diff options
author | buoyantair <buoyantair@protonmail.com> | 2018-11-20 12:28:13 +0530 |
---|---|---|
committer | buoyantair <buoyantair@protonmail.com> | 2018-11-20 12:28:13 +0530 |
commit | bc22d60899e14631cba0fb6450f4e85fc9528293 (patch) | |
tree | 285fa55033bc065df803adc2e4e3142fdfdd7309 /support/doc | |
parent | b9f234371bfaf0d9cfa81e02fcea92cac1f9ae13 (diff) | |
parent | d216b5387fb774d1355df3ace002f7be469bd450 (diff) | |
download | PeerTube-bc22d60899e14631cba0fb6450f4e85fc9528293.tar.gz PeerTube-bc22d60899e14631cba0fb6450f4e85fc9528293.tar.zst PeerTube-bc22d60899e14631cba0fb6450f4e85fc9528293.zip |
Merge branch 'develop' of https://github.com/Chocobozzz/PeerTube into move-utils-to-shared
Diffstat (limited to 'support/doc')
-rw-r--r-- | support/doc/api/openapi.yaml | 11 | ||||
-rw-r--r-- | support/doc/api/quickstart.md | 4 |
2 files changed, 10 insertions, 5 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index af829cc62..aa6be7e87 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -101,14 +101,13 @@ x-tagGroups: | |||
101 | - Video | 101 | - Video |
102 | - Video Channel | 102 | - Video Channel |
103 | - Video Comment | 103 | - Video Comment |
104 | - Video Abuse | ||
105 | - Video Following | 104 | - Video Following |
106 | - Video Rate | 105 | - Video Rate |
107 | - name: Moderation | 106 | - name: Moderation |
108 | tags: | 107 | tags: |
109 | - Video Abuse | 108 | - Video Abuse |
110 | - Video Blacklist | 109 | - Video Blacklist |
111 | - name: Public Instance Information | 110 | - name: Instance Configuration |
112 | tags: | 111 | tags: |
113 | - Config | 112 | - Config |
114 | - Server Following | 113 | - Server Following |
@@ -301,7 +300,7 @@ paths: | |||
301 | responses: | 300 | responses: |
302 | '200': | 301 | '200': |
303 | description: successful operation | 302 | description: successful operation |
304 | /jobs: | 303 | /jobs/{state}: |
305 | get: | 304 | get: |
306 | summary: Get list of jobs | 305 | summary: Get list of jobs |
307 | security: | 306 | security: |
@@ -316,6 +315,12 @@ paths: | |||
316 | description: The state of the job | 315 | description: The state of the job |
317 | schema: | 316 | schema: |
318 | type: string | 317 | type: string |
318 | enum: | ||
319 | - active | ||
320 | - completed | ||
321 | - failed | ||
322 | - waiting | ||
323 | - delayed | ||
319 | - $ref: '#/components/parameters/start' | 324 | - $ref: '#/components/parameters/start' |
320 | - $ref: '#/components/parameters/count' | 325 | - $ref: '#/components/parameters/count' |
321 | - $ref: '#/components/parameters/sort' | 326 | - $ref: '#/components/parameters/sort' |
diff --git a/support/doc/api/quickstart.md b/support/doc/api/quickstart.md index 844248a7f..6c19b59ee 100644 --- a/support/doc/api/quickstart.md +++ b/support/doc/api/quickstart.md | |||
@@ -43,7 +43,7 @@ Response example: | |||
43 | Just use the `access_token` in the `Authorization` header: | 43 | Just use the `access_token` in the `Authorization` header: |
44 | 44 | ||
45 | ``` | 45 | ``` |
46 | $ curl -H 'Authorization: Bearer 90286a0bdf0f7315d9d3fe8dabf9e1d2be9c97d0' https://peertube.example.com/api/v1/jobs/complete | 46 | $ curl -H 'Authorization: Bearer 90286a0bdf0f7315d9d3fe8dabf9e1d2be9c97d0' https://peertube.example.com/api/v1/jobs/completed |
47 | ``` | 47 | ``` |
48 | 48 | ||
49 | 49 | ||
@@ -51,4 +51,4 @@ $ curl -H 'Authorization: Bearer 90286a0bdf0f7315d9d3fe8dabf9e1d2be9c97d0' https | |||
51 | 51 | ||
52 | ``` | 52 | ``` |
53 | $ curl https://peertube.example.com/api/v1/videos | 53 | $ curl https://peertube.example.com/api/v1/videos |
54 | ``` \ No newline at end of file | 54 | ``` |