vervet
vervet copied to clipboard
Need a way to express richer examples in OpenAPI
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?