opensearch-project / opensearch-project/OpenSearch
[BUG] (docs) `ext` object in the request body of Search API is not documented
Open
Nobody has claimed this yet.
bug
Search
- Dominant language
- Java
- Stars
- 13.7k
- Forks
- 3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 108
Description
Describe the bug
The ext object in the request body of Search API is not documented.
Although there is a description of the ext field in the response body
Related component
No response
To Reproduce
Expected behavior
There is a description of the ext field of the request body
Additional Details
Screenshots
Host/Environment (please complete the following information):
- Version 2.19
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 at the Search API request-body section at https://opensearch.org/docs/latest/api-reference/search/#request-body and compare it with the existing response-body description of ext. Update the request-body documentation to describe ext, then verify that the field is visible and accurately explained on the page.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100