fix rest api quickstart and specify values in openapi spec
This commit is contained in:
parent
d175a6f7ab
commit
65f0267930
|
@ -101,14 +101,13 @@ x-tagGroups:
|
||||||
- Video
|
- Video
|
||||||
- Video Channel
|
- Video Channel
|
||||||
- Video Comment
|
- Video Comment
|
||||||
- Video Abuse
|
|
||||||
- Video Following
|
- Video Following
|
||||||
- Video Rate
|
- Video Rate
|
||||||
- name: Moderation
|
- name: Moderation
|
||||||
tags:
|
tags:
|
||||||
- Video Abuse
|
- Video Abuse
|
||||||
- Video Blacklist
|
- Video Blacklist
|
||||||
- name: Public Instance Information
|
- name: Instance Configuration
|
||||||
tags:
|
tags:
|
||||||
- Config
|
- Config
|
||||||
- Server Following
|
- Server Following
|
||||||
|
@ -316,6 +315,12 @@ paths:
|
||||||
description: The state of the job
|
description: The state of the job
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
|
enum:
|
||||||
|
- active
|
||||||
|
- completed
|
||||||
|
- failed
|
||||||
|
- waiting
|
||||||
|
- delayed
|
||||||
- $ref: '#/components/parameters/start'
|
- $ref: '#/components/parameters/start'
|
||||||
- $ref: '#/components/parameters/count'
|
- $ref: '#/components/parameters/count'
|
||||||
- $ref: '#/components/parameters/sort'
|
- $ref: '#/components/parameters/sort'
|
||||||
|
|
|
@ -43,7 +43,7 @@ Response example:
|
||||||
Just use the `access_token` in the `Authorization` header:
|
Just use the `access_token` in the `Authorization` header:
|
||||||
|
|
||||||
```
|
```
|
||||||
$ curl -H 'Authorization: Bearer 90286a0bdf0f7315d9d3fe8dabf9e1d2be9c97d0' https://peertube.example.com/api/v1/jobs/complete
|
$ curl -H 'Authorization: Bearer 90286a0bdf0f7315d9d3fe8dabf9e1d2be9c97d0' https://peertube.example.com/api/v1/jobs/completed
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
@ -51,4 +51,4 @@ $ curl -H 'Authorization: Bearer 90286a0bdf0f7315d9d3fe8dabf9e1d2be9c97d0' https
|
||||||
|
|
||||||
```
|
```
|
||||||
$ curl https://peertube.example.com/api/v1/videos
|
$ curl https://peertube.example.com/api/v1/videos
|
||||||
```
|
```
|
||||||
|
|
Loading…
Reference in New Issue