-
Notifications
You must be signed in to change notification settings - Fork 9.1k
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
Ability to specify more complete examples in a specification #2197
Comments
We also miss this ability. Some of our APIs can only be demonstrated in a meaningful way if a combination of path parameters, query parameters, HTTP headers and a JSON payload (with certain attributes and values) is used. On top of that, it would be super valuable to be able to validate the examples against an actual server as integration/regression test for the documentation. Here is Microsoft's take on this: |
I think this is about not just examples, but which example goes with which other context. #2610 covers similar ground and while I am not sure how we would do this within a specification format, it is a real use case IMO. |
I believe OpenAPI Workflows cover this use case but as far as I understand, a workflow description would live in a separate file to the OpenAPI specification: |
The two requests are being tracked or addressed in:
I'm closing this issue in favor of those. |
I haven't thought a lot about this, but I'm writing a specification with a lot of examples (requests, responses)
The text was updated successfully, but these errors were encountered: