aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/api
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2021-10-27 14:37:04 +0200
committerChocobozzz <chocobozzz@cpy.re>2021-10-29 11:48:21 +0200
commit2760b454a761f6af3138b2fb5f34340772ab0d1e (patch)
tree2b3a2d81478f8b432eb54cce4caa5a760c494627 /support/doc/api
parente4611b54910d8e7f2b4f8a97ee2d9cc8e1054127 (diff)
downloadPeerTube-2760b454a761f6af3138b2fb5f34340772ab0d1e.tar.gz
PeerTube-2760b454a761f6af3138b2fb5f34340772ab0d1e.tar.zst
PeerTube-2760b454a761f6af3138b2fb5f34340772ab0d1e.zip
Deprecate filter video query
Introduce include and isLocal instead
Diffstat (limited to 'support/doc/api')
-rw-r--r--support/doc/api/openapi.yaml60
1 files changed, 42 insertions, 18 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index ef4e7d04d..cdb4dd343 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -367,7 +367,8 @@ paths:
367 - $ref: '#/components/parameters/licenceOneOf' 367 - $ref: '#/components/parameters/licenceOneOf'
368 - $ref: '#/components/parameters/languageOneOf' 368 - $ref: '#/components/parameters/languageOneOf'
369 - $ref: '#/components/parameters/nsfw' 369 - $ref: '#/components/parameters/nsfw'
370 - $ref: '#/components/parameters/filter' 370 - $ref: '#/components/parameters/isLocal'
371 - $ref: '#/components/parameters/include'
371 - $ref: '#/components/parameters/skipCount' 372 - $ref: '#/components/parameters/skipCount'
372 - $ref: '#/components/parameters/start' 373 - $ref: '#/components/parameters/start'
373 - $ref: '#/components/parameters/count' 374 - $ref: '#/components/parameters/count'
@@ -1300,7 +1301,8 @@ paths:
1300 - $ref: '#/components/parameters/licenceOneOf' 1301 - $ref: '#/components/parameters/licenceOneOf'
1301 - $ref: '#/components/parameters/languageOneOf' 1302 - $ref: '#/components/parameters/languageOneOf'
1302 - $ref: '#/components/parameters/nsfw' 1303 - $ref: '#/components/parameters/nsfw'
1303 - $ref: '#/components/parameters/filter' 1304 - $ref: '#/components/parameters/isLocal'
1305 - $ref: '#/components/parameters/include'
1304 - $ref: '#/components/parameters/skipCount' 1306 - $ref: '#/components/parameters/skipCount'
1305 - $ref: '#/components/parameters/start' 1307 - $ref: '#/components/parameters/start'
1306 - $ref: '#/components/parameters/count' 1308 - $ref: '#/components/parameters/count'
@@ -1620,7 +1622,8 @@ paths:
1620 - $ref: '#/components/parameters/licenceOneOf' 1622 - $ref: '#/components/parameters/licenceOneOf'
1621 - $ref: '#/components/parameters/languageOneOf' 1623 - $ref: '#/components/parameters/languageOneOf'
1622 - $ref: '#/components/parameters/nsfw' 1624 - $ref: '#/components/parameters/nsfw'
1623 - $ref: '#/components/parameters/filter' 1625 - $ref: '#/components/parameters/isLocal'
1626 - $ref: '#/components/parameters/include'
1624 - $ref: '#/components/parameters/skipCount' 1627 - $ref: '#/components/parameters/skipCount'
1625 - $ref: '#/components/parameters/start' 1628 - $ref: '#/components/parameters/start'
1626 - $ref: '#/components/parameters/count' 1629 - $ref: '#/components/parameters/count'
@@ -2856,7 +2859,8 @@ paths:
2856 - $ref: '#/components/parameters/licenceOneOf' 2859 - $ref: '#/components/parameters/licenceOneOf'
2857 - $ref: '#/components/parameters/languageOneOf' 2860 - $ref: '#/components/parameters/languageOneOf'
2858 - $ref: '#/components/parameters/nsfw' 2861 - $ref: '#/components/parameters/nsfw'
2859 - $ref: '#/components/parameters/filter' 2862 - $ref: '#/components/parameters/isLocal'
2863 - $ref: '#/components/parameters/include'
2860 - $ref: '#/components/parameters/skipCount' 2864 - $ref: '#/components/parameters/skipCount'
2861 - $ref: '#/components/parameters/start' 2865 - $ref: '#/components/parameters/start'
2862 - $ref: '#/components/parameters/count' 2866 - $ref: '#/components/parameters/count'
@@ -3576,7 +3580,8 @@ paths:
3576 - $ref: '#/components/parameters/licenceOneOf' 3580 - $ref: '#/components/parameters/licenceOneOf'
3577 - $ref: '#/components/parameters/languageOneOf' 3581 - $ref: '#/components/parameters/languageOneOf'
3578 - $ref: '#/components/parameters/nsfw' 3582 - $ref: '#/components/parameters/nsfw'
3579 - $ref: '#/components/parameters/filter' 3583 - $ref: '#/components/parameters/isLocal'
3584 - $ref: '#/components/parameters/include'
3580 - $ref: '#/components/parameters/skipCount' 3585 - $ref: '#/components/parameters/skipCount'
3581 - $ref: '#/components/parameters/start' 3586 - $ref: '#/components/parameters/start'
3582 - $ref: '#/components/parameters/count' 3587 - $ref: '#/components/parameters/count'
@@ -4078,7 +4083,8 @@ paths:
4078 type: string 4083 type: string
4079 - $ref: '#/components/parameters/sort' 4084 - $ref: '#/components/parameters/sort'
4080 - $ref: '#/components/parameters/nsfw' 4085 - $ref: '#/components/parameters/nsfw'
4081 - $ref: '#/components/parameters/filter' 4086 - $ref: '#/components/parameters/isLocal'
4087 - $ref: '#/components/parameters/include'
4082 responses: 4088 responses:
4083 '204': 4089 '204':
4084 description: successful operation 4090 description: successful operation
@@ -4159,7 +4165,8 @@ paths:
4159 required: true 4165 required: true
4160 - $ref: '#/components/parameters/sort' 4166 - $ref: '#/components/parameters/sort'
4161 - $ref: '#/components/parameters/nsfw' 4167 - $ref: '#/components/parameters/nsfw'
4162 - $ref: '#/components/parameters/filter' 4168 - $ref: '#/components/parameters/isLocal'
4169 - $ref: '#/components/parameters/include'
4163 responses: 4170 responses:
4164 '204': 4171 '204':
4165 description: successful operation 4172 description: successful operation
@@ -4792,20 +4799,37 @@ components:
4792 enum: 4799 enum:
4793 - 'true' 4800 - 'true'
4794 - 'false' 4801 - 'false'
4795 filter: 4802 isLocal:
4796 name: filter 4803 name: isLocal
4797 in: query 4804 in: query
4798 required: false 4805 required: false
4799 description: >
4800 Special filters which might require special rights:
4801 * `local` - only videos local to the instance
4802 * `all-local` - only videos local to the instance, but showing private and unlisted videos (requires Admin privileges)
4803 * `all` - all videos, showing private and unlisted videos (requires Admin privileges)
4804 schema: 4806 schema:
4805 type: string 4807 type: boolean
4808 description: 'Display only local or remote videos'
4809 include:
4810 name: include
4811 in: query
4812 required: false
4813 schema:
4814 type: integer
4806 enum: 4815 enum:
4807 - local 4816 - 0
4808 - all-local 4817 - 1
4818 - 2
4819 - 4
4820 - 8
4821 description: >
4822 Include additional videos in results (can be combined using bitwise or operator)
4823
4824 - `0` NONE
4825
4826 - `1` NOT_PUBLISHED_STATE
4827
4828 - `2` HIDDEN_PRIVACY
4829
4830 - `4` BLACKLISTED
4831
4832 - `8` BLOCKED
4809 subscriptionsUris: 4833 subscriptionsUris:
4810 name: uris 4834 name: uris
4811 in: query 4835 in: query
@@ -6995,7 +7019,7 @@ components:
6995 enum: 7019 enum:
6996 - 0 7020 - 0
6997 - 1 7021 - 1
6998 - 3 7022 - 2
6999 Notification: 7023 Notification:
7000 properties: 7024 properties:
7001 id: 7025 id: