opensearch-project / opensearch-project/sql
[FEATURE] Fill out missing specs of this plugin in the API Spec Repo
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 176
- Forks
- 229
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 43
Description
Many endpoints of this plugin have yet to be described in the OpenSearch API Spec repo. Without proper specs, we won't be able to generate clients that can serve these endpoints.
For more details, please check the Developers Guide and the related issue on the spec repo:
https://github.com/opensearch-project/opensearch-api-specification/issues/235
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 the API Spec repository's DEVELOPERS_GUIDE.md and the related issue, opensearch-api-specification#235, to understand how plugin endpoints are represented. Identify the missing endpoint specifications for this plugin and confirm that the completed specs support client generation for those endpoints.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100