cryostatio / cryostatio/cryostat

[Request] OpenAPI schema annotations

Open
#378 2 comments 0 reactions 0 assignees View on GitHub
docs feat
Dominant language
Java
Stars
57
Forks
17
Avg merge
15h 39m
Merged PRs (30d)
42

Description

### 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_

Contributor guide

Open the contributing guide

Research direction

Start by reading the MicroProfile OpenAPI 2.0 annotations section linked in the issue, then inspect the Java sources used for annotation processing and the generated OpenAPI schema. Compare the documented endpoints, parameters, response codes, and response formats with the source, and identify where human-friendly endpoint descriptions and missing schema details are needed. Done means the generated schema includes the intended annotations and descriptions.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi
Domain
api, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.