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

Need a way to express richer examples in OpenAPI #136

Open
cmars opened this issue Feb 3, 2022 · 0 comments
Open

Need a way to express richer examples in OpenAPI #136

cmars opened this issue Feb 3, 2022 · 0 comments

Comments

@cmars
Copy link
Contributor

cmars commented Feb 3, 2022

A single string "example" on a property is not enough to convey:

  • What this property's value looks like structurally and what it means
  • What value I should use for it in a concrete request I'm trying to formulate (maybe the try-it-here in rapidoc?)
  • What possible values I might use for this property and why
  • What values make sense given other values I'm choosing

Is there a set of extensions we can add to properties that doesn't replace the basic "example", but adds enough context to answer the above types of questions to produce rich meaningful documentation?

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

1 participant