aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorRigel Kent <sendmemail@rigelk.eu>2018-11-19 22:07:29 +0100
committerRigel Kent <sendmemail@rigelk.eu>2018-11-19 22:07:38 +0100
commit65f02679303bbf7beebe222eff3ad9394fe23fea (patch)
tree4455436bc039f8e836ff57afc4c0b6dc265aae87
parentd175a6f7ab9dd53e36f9f52769ac02dbfdc57e3e (diff)
downloadPeerTube-65f02679303bbf7beebe222eff3ad9394fe23fea.tar.gz
PeerTube-65f02679303bbf7beebe222eff3ad9394fe23fea.tar.zst
PeerTube-65f02679303bbf7beebe222eff3ad9394fe23fea.zip
fix rest api quickstart and specify values in openapi spec
-rw-r--r--support/doc/api/openapi.yaml9
-rw-r--r--support/doc/api/quickstart.md4
2 files changed, 9 insertions, 4 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index af829cc62..8fbc52e99 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
@@ -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:
43Just use the `access_token` in the `Authorization` header: 43Just 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```