opensearch-project / opensearch-project/opensearch-java
document updating the OpenAPI spec
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 165
- Forks
- 250
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 26
Description
the DEVELOPER_GUIDE.md & co. documents currently do not explain what's happening in java-codegen. please add some documentation for interested developers on where the opensearch-openapi.yaml comes from and what needs to be done to re-generate the code.
this would allow others to experiment with changes & contribute updates more easily.
while i don't know where i could get the OpenAPI spec from i did try running the CodeGenerator - but even just running it on the already present spec generates a huge diff because some javadoc formatting is different (and spotlessApply did not solve it) => there must be some undocumented process to get from that output to what's being committed.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with DEVELOPER_GUIDE.md and the existing documentation around java-codegen, then trace the CodeGenerator entry point and the committed opensearch-openapi.yaml. Document where the spec comes from, the steps required to regenerate code, and how to avoid the javadoc-formatting diff observed after generation and spotlessApply. Done means another developer can reproduce the committed output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, openapi
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100