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

Update openAPI specification to include examples for models #134

Closed
MaartendeKruijf opened this issue Apr 24, 2024 · 1 comment · Fixed by #160
Closed

Update openAPI specification to include examples for models #134

MaartendeKruijf opened this issue Apr 24, 2024 · 1 comment · Fixed by #160
Assignees
Labels
enhancement New feature or request

Comments

@MaartendeKruijf
Copy link
Collaborator

Is your feature request related to a problem? Please describe.
The openAPI cacao model does not contain any example information which makes it hard to use out of the box for a number of reasons.

Describe the solution you'd like
Add example information to the openAPI datamodel like explained https://swagger.io/docs/specification/adding-examples/

Additional context
We encountered the absence of this information whilst fuzzing the API

@MaartendeKruijf MaartendeKruijf self-assigned this Apr 24, 2024
@MaartendeKruijf MaartendeKruijf added the enhancement New feature or request label Apr 24, 2024
@ThomasTNO
Copy link

More info on how to construct examples is given here: https://github.com/swaggo/swag?tab=readme-ov-file#example-value-of-struct

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants