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

Display examples generated from schema along with examples explicitly specified in spec #950

Open
adriansuarez opened this issue Aug 14, 2023 · 0 comments

Comments

@adriansuarez
Copy link

If no examples are specified for an API endpoint, then an example is generated from the schema. For request payloads, this is populated into the request field.

But if examples are specified in the OpenAPI spec, then these generated examples are omitted. I actually find the generated examples useful since they show all fields and it is easy to craft any kind of request payload starting from that. And the explicit examples are obviously useful because they show specific use cases.

It would be good if there was an option to include both the explicit and generated examples.

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