cryostat-legacy icon indicating copy to clipboard operation
cryostat-legacy copied to clipboard

[Request] OpenAPI schema annotations

Open andrewazores opened this issue 10 months ago • 2 comments

Describe the feature

https://download.eclipse.org/microprofile/microprofile-open-api-2.0/microprofile-openapi-spec-2.0.html#_annotations

Currently the OpenAPI schema is quite barren. Since it is autogenerated from annotation processing on the sources it does correctly list all of the endpoints and mostly documents the expected parameters, response codes, and response format, etc., though there are some apparent gaps here and there where source analysis doesn't see the full picture. It would also be good to add some nice human-friendly descriptions of what endpoints are intended to do, as a reference for developers.

Anything other information?

No response

andrewazores avatar Apr 16 '24 18:04 andrewazores