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.

Sign up for GitHub

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

Jump to bottom

[OAS] Support examples #188926

Open
jloleysens opened this issue Jul 23, 2024 · 1 comment
Open

[OAS] Support examples #188926

jloleysens opened this issue Jul 23, 2024 · 1 comment
Labels
Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc

Comments

@jloleysens
Copy link
Contributor

jloleysens commented Jul 23, 2024 •
edited
Loading

We should support providing example values for our runtime schemas and include these in our generated OAS

See OAS docs
@jloleysens jloleysens mentioned this issue Jul 23, 2024
Closed
@botelastic botelastic bot added the needs-team Issues missing a team label label Jul 23, 2024
@jloleysens jloleysens added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS labels Jul 23, 2024
@botelastic botelastic bot removed the needs-team Issues missing a team label label Jul 23, 2024
@jloleysens jloleysens changed the title Support examples ([docs](https://swagger.io/docs/specification/adding-examples/)) [OAS] Support examples Jul 23, 2024
@lcawl
Copy link
Contributor

lcawl commented Aug 9, 2024

As a temporary solution, I've added examples via overlays in #190205

@juliaElastic juliaElastic mentioned this issue Sep 11, 2024
Closed
This was referenced Oct 9, 2024
Merged
Merged
@lcawl lcawl mentioned this issue Nov 4, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jloleysens @lcawl