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

[ResponseOps][Rules] Add deprecation object to deprecated endpoints #196556

Closed
jcger opened this issue Oct 16, 2024 · 3 comments · Fixed by #201550
Closed

[ResponseOps][Rules] Add deprecation object to deprecated endpoints #196556

jcger opened this issue Oct 16, 2024 · 3 comments · Fixed by #201550
Assignees
Labels
Feature:Alerting/RulesFramework Issues related to the Alerting Rules Framework Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)

Comments

@jcger
Copy link
Contributor

jcger commented Oct 16, 2024

We need to replace deprecated: true with the deprecated object in

Copied from #196095:
Here is an example of what true needs to be replaced with (note the options.deprecated param):

  router.versioned
    .get({
      path: '/',
      access: 'public',
      enableQueryVersion: true,
    })
    .addVersion(
      {
        validate: false,
        version: '2023-10-31',
        options: {
          deprecated: {
            documentationUrl: 'https://google.com',
            severity: 'warning',
            reason: {
              type: 'bump',
              newApiVersion: '2024-10-13',
            },
          },
        },
      },

the list of deprecated endpoints can be found here #195179.

Example PR: #198527.

@jcger jcger added Feature:Alerting/RulesFramework Issues related to the Alerting Rules Framework Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) labels Oct 16, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/response-ops (Team:ResponseOps)

@lcawl
Copy link
Contributor

lcawl commented Nov 27, 2024

I presume in addition to the changes in xxx, this means we can update the OpenAPI document (e.g. to remove
api/cases/status from https://github.com/elastic/kibana/blob/main/x-pack/plugins/cases/docs/openapi/entrypoint.yaml so it's no longer published here https://www.elastic.co/docs/api/doc/kibana/operation/operation-getcasestatusdefaultspace)?

jcger added a commit that referenced this issue Nov 28, 2024
…ts (#201550)

## Summary

Adds deprecation object in deprecated alerting routes

Closes #196556

---------

Co-authored-by: lcawl <lcawley@elastic.co>
@jcger
Copy link
Contributor Author

jcger commented Nov 28, 2024

I presume in addition to the changes in xxx, this means we can update the OpenAPI document (e.g. to remove api/cases/status from https://github.com/elastic/kibana/blob/main/x-pack/plugins/cases/docs/openapi/entrypoint.yaml so it's no longer published here https://www.elastic.co/docs/api/doc/kibana/operation/operation-getcasestatusdefaultspace)?

AFAIK as long as it's only for v9 yes. I would include removing the docs entry as part of the issue to remove the endpoints so we do everything at once

jcger added a commit to jcger/kibana that referenced this issue Nov 28, 2024
…ts (elastic#201550)

## Summary

Adds deprecation object in deprecated alerting routes

Closes elastic#196556

---------

Co-authored-by: lcawl <lcawley@elastic.co>
(cherry picked from commit 93b67fb)

# Conflicts:
#	docs/CHANGELOG.asciidoc
CAWilson94 pushed a commit to CAWilson94/kibana that referenced this issue Dec 12, 2024
…ts (elastic#201550)

## Summary

Adds deprecation object in deprecated alerting routes

Closes elastic#196556

---------

Co-authored-by: lcawl <lcawley@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Alerting/RulesFramework Issues related to the Alerting Rules Framework Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants