qugalet/gotosocial
1
0
Fork 0
mirror of https://github.com/superseriousbusiness/gotosocial.git synced 2024-11-26 05:36:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[docs/chore] Swagger fixes for filters (#2730)

Browse source 
* Swagger: filtersV1Get should return an array

* Swagger: context must use multi format
This commit is contained in:
Vyr Cossont 2024-03-07 02:28:57 -08:00 committed by GitHub
parent 5159664a51
commit 74e84cf8fa
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 17 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/api/swagger.yaml
View file

@ -5296,7 +5296,9 @@ paths:
"200": "200":
description: Requested filters. description: Requested filters.
schema: schema:
items:
$ref: '#/definitions/filterV1' $ref: '#/definitions/filterV1'
type: array
"400": "400":
description: bad request description: bad request
"401": "401":
@ -5329,7 +5331,8 @@ paths:
name: phrase name: phrase
required: true required: true
type: string type: string
- description: |- - collectionFormat: multi
description: |-
The contexts in which the filter should be applied. The contexts in which the filter should be applied.
Sample: home, public Sample: home, public
@ -5343,7 +5346,7 @@ paths:
items: items:
type: string type: string
minItems: 1 minItems: 1
name: context name: context[]
required: true required: true
type: array type: array
uniqueItems: true uniqueItems: true
@ -5477,7 +5480,8 @@ paths:
name: phrase name: phrase
required: true required: true
type: string type: string
- description: |- - collectionFormat: multi
description: |-
The contexts in which the filter should be applied. The contexts in which the filter should be applied.
Sample: home, public Sample: home, public
@ -5491,7 +5495,7 @@ paths:
items: items:
type: string type: string
minItems: 1 minItems: 1
name: context name: context[]
required: true required: true
type: array type: array
uniqueItems: true uniqueItems: true

3
internal/api/client/filters/v1/filterpost.go
View file

@ -55,7 +55,7 @@
// maxLength: 40 // maxLength: 40
// type: string // type: string
// - // -
// name: context // name: context[]
// in: formData // in: formData
// required: true // required: true
// description: |- // description: |-
@ -72,6 +72,7 @@
// items: // items:
// type: // type:
// string // string
// collectionFormat: multi
// minItems: 1 // minItems: 1
// uniqueItems: true // uniqueItems: true
// - // -

3
internal/api/client/filters/v1/filterput.go
View file

@ -61,7 +61,7 @@
// maxLength: 40 // maxLength: 40
// type: string // type: string
// - // -
// name: context // name: context[]
// in: formData // in: formData
// required: true // required: true
// description: |- // description: |-
@ -78,6 +78,7 @@
// items: // items:
// type: // type:
// string // string
// collectionFormat: multi
// minItems: 1 // minItems: 1
// uniqueItems: true // uniqueItems: true
// - // -

4
internal/api/client/filters/v1/filtersget.go
View file

@ -43,9 +43,11 @@
// //
// responses: // responses:
// '200': // '200':
// name: filter // name: filters
// description: Requested filters. // description: Requested filters.
// schema: // schema:
// type: array
// items:
// "$ref": "#/definitions/filterV1" // "$ref": "#/definitions/filterV1"
// '400': // '400':
// description: bad request // description: bad request