aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/api/openapi.yaml
diff options
context:
space:
mode:
authorRigel Kent <sendmemail@rigelk.eu>2021-05-10 14:26:17 +0200
committerRigel Kent <sendmemail@rigelk.eu>2021-05-10 14:26:21 +0200
commit985ece57551515e3b10a83c4a826bf35913a992a (patch)
tree76e61d84b4ec07f45aa64018dadfc6f5c870d0cc /support/doc/api/openapi.yaml
parent40cfb36b9d5a709709995ec8d47c1f057729ff07 (diff)
downloadPeerTube-985ece57551515e3b10a83c4a826bf35913a992a.tar.gz
PeerTube-985ece57551515e3b10a83c4a826bf35913a992a.tar.zst
PeerTube-985ece57551515e3b10a83c4a826bf35913a992a.zip
refactor abuses response list to totalDataList in openapi spec
closes #4066
Diffstat (limited to 'support/doc/api/openapi.yaml')
-rw-r--r--support/doc/api/openapi.yaml28
1 files changed, 21 insertions, 7 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index a7501c9d3..bfe3c6da4 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -1867,6 +1867,7 @@ paths:
1867 /users/me/abuses: 1867 /users/me/abuses:
1868 get: 1868 get:
1869 summary: List my abuses 1869 summary: List my abuses
1870 operationId: getMyAbuses
1870 security: 1871 security:
1871 - OAuth2: [] 1872 - OAuth2: []
1872 tags: 1873 tags:
@@ -1882,22 +1883,29 @@ paths:
1882 in: query 1883 in: query
1883 schema: 1884 schema:
1884 $ref: '#/components/schemas/AbuseStateSet' 1885 $ref: '#/components/schemas/AbuseStateSet'
1886 - $ref: '#/components/parameters/abusesSort'
1885 - $ref: '#/components/parameters/start' 1887 - $ref: '#/components/parameters/start'
1886 - $ref: '#/components/parameters/count' 1888 - $ref: '#/components/parameters/count'
1887 - $ref: '#/components/parameters/abusesSort'
1888 responses: 1889 responses:
1889 '200': 1890 '200':
1890 description: successful operation 1891 description: successful operation
1891 content: 1892 content:
1892 application/json: 1893 application/json:
1893 schema: 1894 schema:
1894 type: array 1895 type: object
1895 items: 1896 properties:
1896 $ref: '#/components/schemas/Abuse' 1897 total:
1898 type: integer
1899 example: 1
1900 data:
1901 type: array
1902 items:
1903 $ref: '#/components/schemas/Abuse'
1897 1904
1898 /abuses: 1905 /abuses:
1899 get: 1906 get:
1900 summary: List abuses 1907 summary: List abuses
1908 operationId: getAbuses
1901 security: 1909 security:
1902 - OAuth2: 1910 - OAuth2:
1903 - admin 1911 - admin
@@ -1970,9 +1978,15 @@ paths:
1970 content: 1978 content:
1971 application/json: 1979 application/json:
1972 schema: 1980 schema:
1973 type: array 1981 type: object
1974 items: 1982 properties:
1975 $ref: '#/components/schemas/Abuse' 1983 total:
1984 type: integer
1985 example: 1
1986 data:
1987 type: array
1988 items:
1989 $ref: '#/components/schemas/Abuse'
1976 1990
1977 post: 1991 post:
1978 summary: Report an abuse 1992 summary: Report an abuse