Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enum value description #1316

Closed
Giri-oss opened this issue Aug 12, 2017 · 1 comment
Closed

Enum value description #1316

Giri-oss opened this issue Aug 12, 2017 · 1 comment

Comments

@Giri-oss
Copy link

is there any provision in describing enum value while defining enum in OAI schema format

for example below status property can take values "available, pending or sold" which are defined through enum, i am looking for adding description for each of these values explaining more details about each option like when corresponding option can be used etc. same cane be picked up by API documentation tools for better documentation
status:
type: "string"
description: "pet status in the store"
enum:
- "available"
- "pending"
- "sold"
Giri

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants