Update openAPI specification to include examples for models

COSSAS / SOARCA

SOARCA - The Open Source CACAO-based Security Orchestrator!

https://cossas.github.io/SOARCA/

Apache License 2.0

54 stars 10 forks source link

Update openAPI specification to include examples for models #134

Closed MaartendeKruijf closed 4 months ago

MaartendeKruijf commented 5 months ago

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

ThomasTNO commented 5 months ago

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