Skip to content

Qualify deployment-specific details in API descriptions #4221

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.

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

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

Qualify deployment-specific details in API descriptions #4221

lcawl opened this issue Apr 8, 2025 · 0 comments

Comments

@lcawl
Copy link
Contributor

lcawl commented Apr 8, 2025

Motivation

Since the same specifications are used to generate both the elasticsearch-openapi.json and elasticsearch-serverless-openapi.json, it's possible for some features that are not supported in Serverless, for example, to be mentioned in the descriptions.

There's information about the feature availability within Serverless here: https://www.elastic.co/guide/en/serverless/current/elasticsearch-differences.html#elasticsearch-differences-serverless-feature-categories

Ideally the way that deployment-specific details are described in API docs should align with how this is accomplished in the other docs per https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/versions/content-patterns#prose

Example

_search API discusses Cross Cluster Search, which is not supported for serverless.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant