No, there's no way to describe mutually exclusive parameters.
Yes, that is exactly how the different choices work.
The example thta I already presented is as close to the actual API as I could give in a public forum.
Thanks,
Kevin
It can be defined as follows:
'/fsfd/User/{first_key}':
get:
tags:
- User
summary: Retrieve information on a user.
description: 'Use GET to retrieve information on a user. To do this, specify the user key or email address immediately after /xapis/User/.'
parameters:
- name: first_key
in: path
description: A user key (for example, _abcde12345_) or email address (for example, _user@example.com_).
required: true
schema:
type: string
example: 'user@example.com'
# Or with multiple examples
# (but this is not supported in Swagger UI and Editor yet)
# examples:
# user_key:
# summary: Example of a user key
# value: abcde12345
# email_address:
# summary: Example of an email address
# value: 'user@example.com'Thanks for the prompt reply. I will use the proposed workaround that you have provided but it is shame that something similar does not work with enum.
Would you know if or when Swagger Editor or Swagger UI will support the use of enum in the way described earlier?
This cannot be the first time that two different parameters may be inserted in the same position in a URL path.
Thanks!
Kevin
Hi Kevin,
As Helen explained, enums represent the actual literal values that are valid to that parameter, and they cannot be used to specify two different input types. Enum does not affect the type of the value, but the actual literal value of the parameter.
In OAS3, you can specify multiple parameter values using oneOf.
