'How to add multiple example values in swagger properties?
I am using Swagger OpenAPI Specification tool, I have a string array property in one of the definitions as follows :
cities:
type: array
items:
type: string
example: "Pune"
My API produce JSON result so for above object following result appears in response :
{
"cities": [
"Pune"
]
}
Tried comma separated strings like below :
cities:
type: array
items:
type: string
example: "Pune", "Mumbai", "Bangaluru"
Expecting result as :
{
"cities": [
"Pune",
"Mumbai",
"Bangaluru"
]
}
But the editor shows error. "Bad indentation"
I want to give multiple values to the example tag is there any way ?
Update
User Helen below has given correct answer I had indentaion problem hence there were nested arrays ( 2d arrays )
Correct way :
cities:
type: array
items:
type: string
example:
- Pune
- Mumbai
My way ( Which was wrong )
cities:
type: array
items:
type: string
example:
- Pune
- Mumbai
Look for indentation of example tag in above two cases which makes the difference, Its YAML indentation matters.
Sources
This article follows the attribution requirements of Stack Overflow and is licensed under CC BY-SA 3.0.
Source: Stack Overflow
| Solution | Source |
|---|
