diff options
| author | Chocobozzz <me@florianbigard.com> | 2018-07-17 16:37:28 +0200 |
|---|---|---|
| committer | Chocobozzz <me@florianbigard.com> | 2018-07-17 16:37:54 +0200 |
| commit | 330eaf12969ed0f15f93d5dd50599885f62ffbed (patch) | |
| tree | a5572bbeba128aa5d61701a9305f6d15d009d84c /support/doc/api/commons.yaml | |
| parent | aa1c3d929f524f57930f8bb0ae8b07e8b51f9952 (diff) | |
| download | PeerTube-330eaf12969ed0f15f93d5dd50599885f62ffbed.tar.gz PeerTube-330eaf12969ed0f15f93d5dd50599885f62ffbed.tar.zst PeerTube-330eaf12969ed0f15f93d5dd50599885f62ffbed.zip | |
Fix start/count/sort params in documentation
Diffstat (limited to 'support/doc/api/commons.yaml')
| -rw-r--r-- | support/doc/api/commons.yaml | 23 |
1 files changed, 23 insertions, 0 deletions
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 @@ | |||
| 1 | parameters: | ||
| 2 | start: | ||
| 3 | name: start | ||
| 4 | in: query | ||
| 5 | required: false | ||
| 6 | type: number | ||
| 7 | description: 'Offset' | ||
| 8 | count: | ||
| 9 | name: count | ||
| 10 | in: query | ||
| 11 | required: false | ||
| 12 | type: number | ||
| 13 | description: 'Number of items' | ||
| 14 | sort: | ||
| 15 | name: sort | ||
| 16 | in: query | ||
| 17 | required: false | ||
| 18 | type: string | ||
| 19 | description: 'Sort column (-createdAt for example)' | ||
| 20 | |||
| 21 | responses: | ||
| 22 | emptySuccess: | ||
| 23 | description: 'Successful operation' \ No newline at end of file | ||