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

Support a discontinued or remove-by indicator #2872

Closed
lcawl opened this issue Sep 6, 2024 · 1 comment
Closed

Support a discontinued or remove-by indicator #2872

lcawl opened this issue Sep 6, 2024 · 1 comment

Comments

@lcawl
Copy link
Contributor

lcawl commented Sep 6, 2024

🚀 Feature Proposal

Relates to elastic/kibana#192292

Motivation

In circumstances where we know the date or version at which a "deprecated" item will move to "discontinued", that information is useful to communicate to users in advance.

Example

For example, the information could be added to the specification then output in the OpenAPI document as follows:

"components": {
  "parameters": {
      "scroll#scroll_id": {
        "in": "path",
        "name": "scroll_id",
        "description": "The scroll ID",
        "required": true,
        "deprecated": true,
        "x-discontinued": 9.0.0,
        "schema": {
          "$ref": "#/components/schemas/_types:ScrollId"
        },
        "style": "simple"
      },
@TinaHeiligers
Copy link

Kibana will be using x-state to indicate API stability and will not need to support the custom x-discontinued property.
@lcawl I'm going to close this issue as not needed. Feel free to reopen if needed in the future.

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

2 participants