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][Cases] Add deprecation object to deprecated endpoints #196557

Closed
jcger opened this issue Oct 16, 2024 · 2 comments · Fixed by #201004
Closed

[ResponseOps][Cases] Add deprecation object to deprecated endpoints #196557

jcger opened this issue Oct 16, 2024 · 2 comments · Fixed by #201004
Assignees
Labels
Feature:Cases Cases feature 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 #194266.

Example PR: #198527.

@jcger jcger added Feature:Cases Cases feature 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-cases (Feature:Cases)

@elasticmachine
Copy link
Contributor

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

jcger added a commit that referenced this issue Nov 27, 2024
## Summary

Adds deprecation object in deprecated cases routes

Closes [#196557](#196557)

---------

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue Nov 27, 2024
## Summary

Adds deprecation object in deprecated cases routes

Closes [elastic#196557](elastic#196557)

---------

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
(cherry picked from commit 0735ab8)
kibanamachine added a commit that referenced this issue Nov 27, 2024
# Backport

This will backport the following commits from `main` to `8.x`:
- [[Response Ops][Cases] Use deprecation object
(#201004)](#201004)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Julian
Gernun","email":"17549662+jcger@users.noreply.github.com"},"sourceCommit":{"committedDate":"2024-11-27T10:37:49Z","message":"[Response
Ops][Cases] Use deprecation object (#201004)\n\n## Summary\r\n\r\nAdds
deprecation object in deprecated cases routes\r\n\r\nCloses
[#196557](https://github.com/elastic/kibana/issues/196557)\r\n\r\n---------\r\n\r\nCo-authored-by:
Lisa Cawley
<lcawley@elastic.co>","sha":"0735ab8196e7d11fb099b564b2c9b03ce840aa36","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","v9.0.0","Feature:Cases","backport:prev-minor","v8.18.0"],"title":"[Response
Ops][Cases] Use deprecation
object","number":201004,"url":"https://github.com/elastic/kibana/pull/201004","mergeCommit":{"message":"[Response
Ops][Cases] Use deprecation object (#201004)\n\n## Summary\r\n\r\nAdds
deprecation object in deprecated cases routes\r\n\r\nCloses
[#196557](https://github.com/elastic/kibana/issues/196557)\r\n\r\n---------\r\n\r\nCo-authored-by:
Lisa Cawley
<lcawley@elastic.co>","sha":"0735ab8196e7d11fb099b564b2c9b03ce840aa36"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/201004","number":201004,"mergeCommit":{"message":"[Response
Ops][Cases] Use deprecation object (#201004)\n\n## Summary\r\n\r\nAdds
deprecation object in deprecated cases routes\r\n\r\nCloses
[#196557](https://github.com/elastic/kibana/issues/196557)\r\n\r\n---------\r\n\r\nCo-authored-by:
Lisa Cawley
<lcawley@elastic.co>","sha":"0735ab8196e7d11fb099b564b2c9b03ce840aa36"}},{"branch":"8.x","label":"v8.18.0","branchLabelMappingKey":"^v8.18.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Julian Gernun <17549662+jcger@users.noreply.github.com>
CAWilson94 pushed a commit to CAWilson94/kibana that referenced this issue Dec 12, 2024
## Summary

Adds deprecation object in deprecated cases routes

Closes [elastic#196557](elastic#196557)

---------

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Cases Cases feature 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.

2 participants