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

[Request] OpenAPI schema annotations #378

Open
andrewazores opened this issue Apr 16, 2024 · 2 comments
Open

[Request] OpenAPI schema annotations #378

andrewazores opened this issue Apr 16, 2024 · 2 comments
Labels
docs feat New feature or request

Comments

@andrewazores
Copy link
Member

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
Copy link
Member Author

andrewazores commented Jul 19, 2024

@andrewazores
Copy link
Member Author

andrewazores commented Jul 19, 2024

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

No branches or pull requests

1 participant