Commit Graph

342 Commits

Author SHA1 Message Date
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