OpenAPI Spec - define an error structure

[sebastian-bury]

Describe the feature request

Currently the specification does not provide an error structure. An error structure would help be able to gracefully and better handle errors if they are seen.

Background

No response

Solution suggestions

No response

[sebastian-bury]

Additional notes:

Should have at least one error structure at paths:
- paths./api/client/features.get
- paths./api/client/features/{featureName}.get
- paths./api/client/metrics.post
- paths./api/client/register.post
- paths./health.get

Missing error schema at path:
- paths./api/client/metrics.post.responses.400

Should have required property 'errors' at path:
- paths./health.get.responses.500.schema.properties

[thomasheartman]

@sebastian-bury Just out of curiosity: where did you get the data for the additional notes? Why should all those endpoints have at least one error structure etc? Not saying it's wrong at all, just curious where that came from ☺️