Skip to content
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

[BUG] Mark APIs experimental vs. stable #158

Open
saimedhi opened this issue Oct 10, 2023 · 3 comments
Open

[BUG] Mark APIs experimental vs. stable #158

saimedhi opened this issue Oct 10, 2023 · 3 comments
Labels
enhancement New feature or request

Comments

@saimedhi
Copy link
Contributor

What is the bug?

The OpenSearch API specification lacks a parameter or key to indicate the stability status of an endpoint (whether it's experimental or stable)

What is the expected behavior?

A parameter or key to indicate the stability status of an endpoint (whether it's experimental or stable)

@saimedhi saimedhi added bug Something isn't working untriaged labels Oct 10, 2023
@dblock dblock added missing api Missing API or api parameter that needs to be added. and removed untriaged labels Dec 20, 2023
@nhtruong
Copy link
Collaborator

nhtruong commented Apr 2, 2024

We should add x-experimental: true extension.

@Xtansia
Copy link
Collaborator

Xtansia commented Apr 2, 2024

This potentially should be an enum of x-stability: (stable|experimental) (with stable being assumed if not present). As we might have multiple levels of stability present within the server. From elastic I believe it was stable, beta, experimental or something similar, so not sure if that scheme is still in use by OpenSearch core.

@dblock dblock changed the title [BUG]The OpenSearch API specification lacks a parameter or key to indicate the stability status of an endpoint (whether it's experimental or stable) [BUG] Mark APIs experimental vs. stable Jun 4, 2024
@dblock dblock added enhancement New feature or request and removed bug Something isn't working missing api Missing API or api parameter that needs to be added. labels Jun 4, 2024
@dblock
Copy link
Member

dblock commented Jun 4, 2024

All APIs are considered stable unless marked experimental in OpenSearch, we should match that and only add x-experimental.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants