Object Category | Supported Objects or Fields |
---|---|
Swagger | swagger |
info | |
host | |
basepath | |
schemes | |
consumes | |
produces | |
paths | |
definitions | |
parameters | |
responses | |
Paths | /{path} |
Path Item | $ref |
get | |
put | |
post | |
delete | |
parameters | |
Operation | Summary Note: If operation ID value is not defined, the value of summary field is treated as operation ID. |
operationId | |
consumes | |
produces | |
parameters | |
responses | |
schemes | |
Parameter Type | path |
query | |
header | |
formData | |
cookie | |
body | |
Parameter Fields | name |
In If in is body, the supported field is schema. If in is any value other than body, the supported fields are type, format, and items. | |
required | |
Items | type |
format | |
items | |
Response | schema |
Response Schema | $ref |
format | |
type | |
items | |
properties | |
Definitions | {name} |