List of possible values for API query parameter in Swagger

Question

When documenting an API, is there a way to provide a list of possible values? Something like this:

{
  "name": "propertyType",
  "in": "query",
  "description": "Type of home",
  "required": false,
  "type": "list",
  "listValues": ["singleFamilyHome", "condo", "farm", …]
}

Possible duplicate of [How to define enum in swagger.io?](http://stackoverflow.com/questions/27603871/how-to-define-enum-in-swagger-io) — Helen, May 25 '16 at 11:36

score 8 · Accepted Answer · edited May 23 '17 at 12:02

8

In swagger 2.0 you can use enum:

{
  "name": "propertyType",
  "in": "query",
  "description": "Type of home",
  "required": false,
  "type": "list",
  "enum": ["singleFamilyHome", "condo", "farm"]
}

You ca find more info here: How to define enum in swagger.io?

edited May 23 '17 at 12:02

Community

1
1

answered Sep 30 '15 at 15:49

David Lopez

2,127
1
10
7

List of possible values for API query parameter in Swagger

1 Answers1