Skip to content

[DOC] Analyze API documentation incorrectly lists body content as query params #6353

@justindgm

Description

@justindgm

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request. Provide a summary of the request and all versions that are affected.

The latest documentation for the Analyze API at https://opensearch.org/docs/latest/api-reference/analyze-apis/ lists a number of optional and required query parameters for requests to /_analyze, such as "text" and "analyzer". However, in reality these parameters actually need to be in the body of the request.

For example, the following is a valid request to the /_analyze path:
curl -X GET "https://localhost:9200/_analyze?pretty" -ku 'admin:admin' -H 'Content-Type: application/json' -d'{"analyzer": "standard", "text": "this is a test"}'

However, this is an invalid request:
curl -X GET "https://localhost:9200/_analyze?analyzer=standard&text=this%20is%20a%20test" -ku 'admin:admin'

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.

Metadata

Metadata

Assignees

Labels

Backlog - DOCDoc writer assigned to issue responsible for creating PR.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions