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?

Helen
– Helen

2016-05-25 11:36:12 +00:00
Commented May 25, 2016 at 11:36 — Helen
– Helen, Commented May 25, 2016 at 11:36

Community · Accepted Answer · 2017-05-23 12:02:21Z

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, 2017 at 12:02

CommunityBot

11 silver badge

answered Sep 30, 2015 at 15:49

David Lopez

2,2671 gold badge13 silver badges7 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

List of possible values for API query parameter in Swagger

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related