From: Chocobozzz Date: Tue, 17 Jul 2018 14:37:28 +0000 (+0200) Subject: Fix start/count/sort params in documentation X-Git-Tag: v1.0.0-beta.10.pre.1~45 X-Git-Url: https://git.immae.eu/?a=commitdiff_plain;h=330eaf12969ed0f15f93d5dd50599885f62ffbed;hp=aa1c3d929f524f57930f8bb0ae8b07e8b51f9952;p=github%2FChocobozzz%2FPeerTube.git Fix start/count/sort params in documentation --- 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