No, there's no way to describe mutually exclusive parameters.
Hi Kevin,
An enum specifies the actual values for a parameter, so your definition means that the URL can be literally either
/fsfd/User/user_key
or
/fsfd/User/email_address
Could you please provide some examples of how the actual URLs look like?
Do they look like this?
https://dev.test.com/xapis/User/abcde123545 https://dev.test.com/xapis/User/user@example.com
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.
