Skip to content

Update externalDocs links in _search endpoint #4222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
lcawl opened this issue Apr 8, 2025 · 0 comments
Open

Update externalDocs links in _search endpoint #4222

lcawl opened this issue Apr 8, 2025 · 0 comments
Labels
documentation

Comments

@lcawl
Copy link
Contributor

lcawl commented Apr 8, 2025 •
edited
Loading

We received feedback that the external documentation link in https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-search is a link to “Remote Clusters”, which is not relevant for Serverless. "...Instead, it seems like the “External documentation” link should be pointing to this page on pagination instead..."
This information is generated from https://github.com/elastic/elasticsearch-specification/blob/main/specification/_global/search/SearchRequest.ts, in particular the @ext_doc_id.

Since the same specifications are used to generate both the elasticsearch-openapi.json and elasticsearch-serverless-openapi.json, ideally we can find a link that is applicable to both (the external documentation object can contain only a single link). Otherwise if there are lots of links like this that must be deployment-specific we might need to re-open #2297
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@lcawl