Matthieu De Beule
f6d51cfe2a
Fix Ruby and Python REST API examples
...
The previous examples where wrong, since they used a POST request.
I used the requests library for Python, since that is what most people
would want to use.
I removed the http.verify_mode in the Ruby example since I don't think
it is good practice to tell people to not verify HTTPS requests
2019-11-12 14:46:43 +01:00
Chocobozzz
e8e09e27ff
Bumped to version v2.0.0
2019-11-12 08:04:15 +01:00
Chocobozzz
16fd7c4b86
Bumped to version v2.0.0-rc.1
2019-10-29 08:26:43 +01:00
Chocobozzz
747b17c7c1
Fix openapi
2019-10-29 08:26:24 +01:00
Frank Sträter
a1b572ea76
Remove feeds from API documentation
2019-09-18 15:24:33 +02:00
Chocobozzz
8c559fad1e
Merge branch 'release/1.4.0' into develop
2019-09-11 11:09:18 +02:00
Chocobozzz
22af8aac79
Bumped to version v1.4.1
2019-09-09 08:15:24 +02:00
Chocobozzz
076d3ace1e
Bumped to version v1.4.0
2019-08-26 11:56:10 +02:00
Chocobozzz
f01dc977ae
Bumped to version v1.4.0
2019-08-26 08:49:46 +02:00
Frank Sträter
2a8ae7595c
Update API documentation for accounts and config ( #2072 )
...
* Update Actor and Account schemas
* Fix mixed up paramaters for /accounts
* Update ServerConfig schema
* Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 13:33:07 +02:00
Frank Sträter
0ad45af705
Improved description of all file uploads ( #2053 )
...
* Add format:binary for file uploads
* Fix wrongly named field for encoding
* Fix typo in field name
* Add contentType for torrentfile and captionfile
* Add contentType for videofile
2019-08-21 08:32:15 +02:00
Frank Sträter
37db4176f2
Add originallyPublishedAt to PUT videos + change HTTP response to 204
2019-08-14 11:10:17 +02:00
Chocobozzz
54beb819f0
Bumped to version v1.4.0-rc.1
2019-08-13 15:34:39 +02:00
Frank Sträter
07d02f6de8
Specify the restrictions on tags array and it's string items ( #2016 )
...
* Fixed 2 typos
* Specify tags array restrictions
2019-08-12 10:19:45 +02:00
Frank Sträter
b3d1054e86
Fixed 2 typos
2019-08-07 10:36:22 +02:00
Frank Sträter
f9f8909298
Add originallyPublishedAt in /videos/upload to the OpenAPI document
2019-08-05 14:18:03 +02:00
Chocobozzz
bfbd912886
Fix broken playlist api
2019-08-01 09:11:04 +02:00
Chocobozzz
1f82e3e885
Add video import in open api
2019-07-29 14:33:16 +02:00
Chocobozzz
094ff8e692
Fix mocha commands
2019-07-29 14:16:03 +02:00
Dirk Kelly
512a575971
Updated openapi.html ExternalDocs url
2019-07-08 16:06:55 +02:00
Chocobozzz
cb9d028a6b
Fix openapi schema
2019-07-03 17:28:09 +02:00
Chocobozzz
b6a1dd4d1b
Merge branch 'release/v1.3.0' into develop
2019-06-17 09:48:41 +02:00
Chocobozzz
0109c4921c
Bumped to version v1.3.1
2019-06-17 08:38:32 +02:00
Chocobozzz
5dce26d202
Improve video REST documentation
2019-06-11 10:01:22 +02:00
Chocobozzz
1f20622f2b
Improve registration
...
* Add ability to set the user display name
* Use display name to guess the username/channel name
* Add explanations about what is the purpose of a username/channel name
* Add a loader at the "done" step
2019-06-07 17:05:42 +02:00
Chocobozzz
a41b9da1a9
Merge branch 'release/v1.3.0' into develop
2019-06-03 09:32:33 +02:00
Chocobozzz
88ebb43310
Bumped to version v1.3.0
2019-06-03 08:47:25 +02:00
Chocobozzz
7d14d4d2ca
Server: Bulk update videos support field
2019-05-31 16:44:46 +02:00
Raphael
089caedc6f
refactor(docs): typo in Open API reference
2019-05-24 13:53:43 +02:00
Chocobozzz
048b694661
Fix videos list response in rest api doc
2019-05-24 10:17:54 +02:00
Chocobozzz
ee89e8fd1a
Fix video privacy in rest api documentation
2019-05-24 10:09:27 +02:00
Chocobozzz
67ae04a5e7
Add video caption rest api doc
2019-05-24 10:01:08 +02:00
Chocobozzz
63d17405d0
Fix role documentation in rest api
2019-05-24 09:25:30 +02:00
Chocobozzz
46e9407c60
Update URLs to point to new documentation site
2019-05-23 14:58:34 +02:00
Chocobozzz
faebb42355
Bumped to version v1.3.0-rc.2
2019-05-22 09:37:13 +02:00
Chocobozzz
ea0877b405
Bumped to version v1.3.0-rc.2
2019-05-22 08:22:14 +02:00
Chocobozzz
3fbbadabea
Bumped to version v1.3.0-rc.1
2019-05-14 14:00:03 +02:00
Chocobozzz
ff40a4ebab
dailyVideoQuota -> videoQuotaDaily in doc
2019-04-24 17:35:59 +02:00
Chocobozzz
9ce3d3027e
Fix video channel API route param in doc
2019-04-24 16:57:34 +02:00
Chocobozzz
fbe1bc2afa
Add videoQuotaDaily in documentation
2019-04-24 16:54:17 +02:00
Yohan Boniface
c100a6142e
Add /accounts/:username/ratings endpoint ( #1756 )
...
* Add /users/me/videos/ratings endpoint
* Move ratings endpoint from users to accounts
* /accounts/:name/ratings: add support for rating= and sort=
* Restrict ratings list to owner
* Wording and better way to ensure current account
2019-04-09 11:02:02 +02:00
Mathieu Agopian
12fed49eba
Add the video tags restrictions to the API docs
...
Fixes #1744
2019-03-29 16:58:05 +01:00
Chocobozzz
28c8e63e55
Add video import enpoint in openapi
2019-02-19 17:56:50 +01:00
Chocobozzz
301fc49c17
Bumped to version v1.2.1
2019-02-15 09:43:39 +01:00
Chocobozzz
f5305c04aa
Bumped to version v1.2.0
2019-02-06 11:57:57 +01:00
Chocobozzz
cfeae291c0
Bumped to version v1.2.0-rc.1
2019-01-17 16:15:20 +01:00
Chocobozzz
1fd12c7cfa
Fix video tags update/upload in openapi
2019-01-09 14:10:25 +01:00
Rigel Kent
e76d578414
(doc) update API spec to include user subscription routes
2019-01-03 18:00:29 +01:00
Rigel Kent
f50ab1c289
(doc) fix syntax in openapi spec for watching progress
2018-12-08 18:56:12 +01:00
Rigel Kent
2beb98952a
change type of languageOneOf query parameter
2018-12-04 13:51:10 +01:00
Chocobozzz
b6ff69719d
Bumped to version v1.1.0
2018-12-04 08:29:12 +01:00
Rigel Kent
fd5af7a269
add parameters to GET /videos route spec
2018-11-24 18:18:56 +01:00
Chocobozzz
6cc98dfff3
Add open api bump version in release script
2018-11-22 15:04:14 +01:00
Rigel Kent
0f49023061
make POST /users have integer role enum
2018-11-21 11:52:30 +01:00
Rigel Kent
d216b5387f
add job state in path in openapi spec
2018-11-19 22:10:35 +01:00
Rigel Kent
65f0267930
fix rest api quickstart and specify values in openapi spec
2018-11-19 22:07:38 +01:00
Rigel Kent
9d0b856e93
(quickfix) typo in openapi spec groups
2018-11-17 15:17:33 +01:00
Rigel Kent
9ab81fc4a9
grouping moderation endpoints in the REST API spec
2018-11-17 15:16:01 +01:00
Rigel Kent
5776f78e3b
grouping tags by main category in the spec
2018-11-16 14:33:49 +01:00
Rigel Kent
6441981bc6
adding ownership and watching video APIs to the spec
2018-11-16 13:31:24 +01:00
Rigel Kent
cfd140abd6
remove superfluous privacy field for upload
2018-11-16 13:31:23 +01:00
Rigel Kent
8f9e8be1fc
fix API spec on POST /videos/upload and provide Shell example
2018-11-15 17:09:25 +01:00
Rigel Kent
3e9e6f2f14
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 14:10:16 +01:00
Rigel Kent
2963c3432f
updated REST API documentation
2018-11-13 23:32:55 +01:00
Rigel Kent
1d859b5afa
sync API version with PeerTube version and auto-update it via git hooks
2018-11-13 14:31:48 +01:00
David Libeau
655b549048
Correct API documentation for search ( #881 )
2018-07-29 22:26:05 +02:00
David Libeau
fb72c19384
Correct API documentation for search ( #878 )
2018-07-28 20:38:49 +02:00
Chocobozzz
330eaf1296
Fix start/count/sort params in documentation
2018-07-17 16:37:54 +02:00
William Lahti
999417328b
Ability to programmatically control embeds ( #776 )
...
* first stab at jschannel based player api
* semicolon purge
* more method-level docs; consolidate definitions
* missing definitions
* better match peertube's class conventions
* styling for embed tester
* basic docs
* add `getVolume`
* document the test-embed feature
2018-07-10 17:47:56 +02:00
PhieF
61b909b9bf
Filter by category ( #720 )
...
* get videos with specific category (api)
* update api doc with category
* add url parameter to filter by category
* fix lint issues
2018-06-27 14:24:49 +02:00
Chocobozzz
bbe0f0645c
Add ability to schedule video publication
2018-06-15 18:20:56 +02:00
Chocobozzz
2186386cca
Add concept of video state, and add ability to wait transcoding before
...
publishing a video
2018-06-12 20:37:51 +02:00
Chocobozzz
f286060081
Add API example to list videos
2018-06-11 14:45:43 +02:00
Chocobozzz
ad9e39fb81
Only use account name in routes
2018-05-25 10:41:07 +02:00
Chocobozzz
cc918ac3f4
Update video-channel routes (again)
...
Use /video-channels now, it's more simple for clients
2018-04-25 16:16:21 +02:00
Chocobozzz
6b738c7a31
Video channel API routes refractor
2018-04-25 13:50:48 +02:00
Chocobozzz
48dce1c90d
Update video channel routes
2018-04-24 17:12:57 +02:00
Chocobozzz
9d3ef9fe05
Use ISO 639 for languages
2018-04-23 14:39:52 +02:00
Chocobozzz
c0c7416a23
Add rest api quickstart
2018-04-17 11:12:37 +02:00
Rigel Kent
244e76a552
feature: initial syndication feeds support
...
Provides rss 2.0, atom 1.0 and json 1.0 feeds for videos (instance and account-wide) on listings and video-watch views.
* still lacks redis caching
* still lacks lastBuildDate support
* still lacks channel-wide support
* still lacks semantic annotation (for licenses, NSFW warnings, etc.)
* still lacks love ( ˘ ³˘)
* RSS: has MRSS support for torrent lists!
* RSS: includes the first torrent in an enclosure
* JSON: lists all torrents in the 'attachments' object
* ATOM: lacking torrent listing support
Advances #23
Partial implementation for the accountId generation in the client, which will need a hotfix to add a way to get the proper account id.
2018-04-17 01:09:06 +02:00
Chocobozzz
94ff4c2335
Add auth documentation
2018-04-16 17:27:00 +02:00
Chocobozzz
228e84aa7e
Upgrade spectacle module
2018-04-06 10:44:02 +02:00
Chocobozzz
97ea24045d
Fix api doc in video update endpoint
2018-04-06 10:20:11 +02:00
Chocobozzz
61b66b361f
Upgrade api doc
2018-04-06 10:17:06 +02:00
luz.paz
f209b32afa
Misc. typos
...
Found via `codespell -q 3`
2018-03-30 18:51:57 +02:00
Chocobozzz
164e6c8778
Prepare beta
2018-03-20 10:32:54 +01:00
Chocobozzz
5d00a3d7aa
Update the api documentation
2018-03-19 14:20:04 +01:00
Chocobozzz
19a3b914f1
Change video abuse API response
2018-03-12 11:44:28 +01:00
Chocobozzz
b64c950a1c
Update videos api list for account
2018-03-12 11:44:28 +01:00
Chocobozzz
ea65a47623
Add api base path in documentation
2018-03-07 13:13:40 +01:00
Chocobozzz
ab0ee6a14f
Upgrade api doc html file
2018-03-07 08:11:38 +01:00
Dimitri Gilbert
44cb3b85f8
Apidoc ( #302 )
...
* Basic api documentation
* fix styling issue
* fix styling issue
* gitignore unecessary folders
* openApi 2.0 first draft
* solved conflicts
* solved errors in openapi file
* added missing doc on video + deleted apidoc comments
* fix last warnings and errors inopenapi definition
* openapi fix typo + improvement on video/comment endpoints
* removed misplaced openapi file
* api documentation improvement
2018-02-17 19:24:56 +01:00
Dimitri Gilbert
c360c49456
Api doc improvement ( #252 )
...
* Basic api documentation
* fix styling issue
* fix styling issue
* gitignore unecessary folders
* openApi 2.0 first draft
* solved conflicts
* solved errors in openapi file
* added missing doc on video + deleted apidoc comments
* fix last warnings and errors inopenapi definition
* openapi fix typo + improvement on video/comment endpoints
* removed misplaced openapi file
2018-01-25 18:39:51 +01:00
Chocobozzz
5e1c08eb94
Add api doc in html
2018-01-24 11:54:32 +01:00
Chocobozzz
9ee83eb99e
Fix tests
2018-01-24 11:03:13 +01:00