From 330eaf12969ed0f15f93d5dd50599885f62ffbed Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Tue, 17 Jul 2018 16:37:28 +0200 Subject: [PATCH] Fix start/count/sort params in documentation --- support/doc/api/accounts.yaml | 7 + support/doc/api/commons.yaml | 23 + support/doc/api/html/index.html | 1604 +++++++++-------- .../doc/api/html/javascripts/spectacle.min.js | 2 +- .../doc/api/html/stylesheets/foundation.css | 42 +- .../api/html/stylesheets/foundation.min.css | 2 +- .../doc/api/html/stylesheets/spectacle.css | 29 +- .../api/html/stylesheets/spectacle.min.css | 2 +- support/doc/api/openapi.yaml | 580 ++---- support/doc/api/users.yaml | 7 + support/doc/api/video-channels.yaml | 7 + support/doc/api/video-comments.yaml | 13 + support/doc/api/videos.yaml | 87 + 13 files changed, 1148 insertions(+), 1257 deletions(-) create mode 100644 support/doc/api/accounts.yaml create mode 100644 support/doc/api/commons.yaml create mode 100644 support/doc/api/users.yaml create mode 100644 support/doc/api/video-channels.yaml create mode 100644 support/doc/api/video-comments.yaml create mode 100644 support/doc/api/videos.yaml diff --git a/support/doc/api/accounts.yaml b/support/doc/api/accounts.yaml new file mode 100644 index 000000000..c5b20040d --- /dev/null +++ b/support/doc/api/accounts.yaml @@ -0,0 +1,7 @@ +parameters: + name: + name: name + in: path + required: true + type: string + description: 'The name of the account (chocobozzz or chocobozzz@peertube.cpy.re for example)' \ No newline at end of file diff --git a/support/doc/api/commons.yaml b/support/doc/api/commons.yaml new file mode 100644 index 000000000..c8bab3c80 --- /dev/null +++ b/support/doc/api/commons.yaml @@ -0,0 +1,23 @@ +parameters: + start: + name: start + in: query + required: false + type: number + description: 'Offset' + count: + name: count + in: query + required: false + type: number + description: 'Number of items' + sort: + name: sort + in: query + required: false + type: string + description: 'Sort column (-createdAt for example)' + +responses: + emptySuccess: + description: 'Successful operation' \ No newline at end of file diff --git a/support/doc/api/html/index.html b/support/doc/api/html/index.html index 24017e674..bf9b6a17b 100644 --- a/support/doc/api/html/index.html +++ b/support/doc/api/html/index.html @@ -173,10 +173,10 @@ VideoBlacklist