Usar parâmetro de consulta de tipo de objeto na documentação do swagger
Eu tenho uma rota GET na qual gostaria de codificar um parâmetro de objeto no URL como uma string de consulta.
Ao escrever a documentação do swagger, basicamente recebo erros que não me permitem usarschema
/object
tipos em umquery
parâmetro de tipo:
paths:
/mypath/:
get:
parameters
- in: path
name: someParam
description: some param that works
required: true
type: string
format: timeuuid #good param, works well
- $ref: "#/parameters/mySortingParam" #this yields an error
parameters:
mySortingParam
name: paging
in: query
description: Holds various paging attributes
required: false
schema:
type: object
properties:
pageSize:
type: number
cursor:
type: object
properties:
after:
type: string
format: string
O parâmetro de consulta de solicitação com um valor de objeto seria codificado em uma solicitação real.
Embora o swagger mostre um erro na parte superior da tela, o objeto é renderizado corretamente no editor de interface do usuário do swagger, no entanto, com esse erro flutuando na parte superior da documentação.