From 65f02679303bbf7beebe222eff3ad9394fe23fea Mon Sep 17 00:00:00 2001 From: Rigel Kent Date: Mon, 19 Nov 2018 22:07:29 +0100 Subject: fix rest api quickstart and specify values in openapi spec --- support/doc/api/openapi.yaml | 9 +++++++-- support/doc/api/quickstart.md | 4 ++-- 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: - Video - Video Channel - Video Comment - - Video Abuse - Video Following - Video Rate - name: Moderation tags: - Video Abuse - Video Blacklist - - name: Public Instance Information + - name: Instance Configuration tags: - Config - Server Following @@ -316,6 +315,12 @@ paths: description: The state of the job schema: type: string + enum: + - active + - completed + - failed + - waiting + - delayed - $ref: '#/components/parameters/start' - $ref: '#/components/parameters/count' - $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: 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 -``` \ No newline at end of file +``` -- cgit v1.2.3