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.

Sign up for GitHub

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

Jump to bottom

[DOCS] Add deprecation details to case APIs #152033

Merged
merged 5 commits into from
Feb 28, 2023
Merged

[DOCS] Add deprecation details to case APIs #152033

merged 5 commits into from
Feb 28, 2023

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Feb 23, 2023 •
edited by kibanamachine
Loading

Summary

This PR updates the open API specifications to include more information about the deprecated operations and parameters in the case APIs. The details about when the deprecations were introduced was gleaned from the existing documentation in https://www.elastic.co/guide/en/kibana/master/cases-api.html

I have also changed the operationIds for the _find endpoints so they all contain find in their identifier.

@lcawl lcawl added Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) docs Feature:Cases Cases feature backport:prev-minor Backport to (9.0) the previous minor version (i.e. one version back from main) v8.7.0 v8.8.0 labels Feb 23, 2023
@github-actions
Copy link
Contributor

Documentation preview:

@lcawl lcawl requested a review from cnasikas February 23, 2023 21:14
@lcawl lcawl marked this pull request as ready for review February 23, 2023 21:14
@lcawl lcawl requested a review from a team as a code owner February 23, 2023 21:14
@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

Pinging @elastic/response-ops-cases (Feature:Cases)

@lcawl lcawl added the release_note:skip Skip the PR/issue when compiling release notes label Feb 23, 2023
@lcawl lcawl enabled auto-merge (squash) February 28, 2023 15:31
@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

Unknown metric groups

ESLint disabled line counts

id before after diff
securitySolution 428 430 +2

Total ESLint disabled count

id before after diff
securitySolution 506 508 +2

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

szabosteve
szabosteve approved these changes Feb 28, 2023
View reviewed changes
Copy link
Contributor

@szabosteve szabosteve left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@lcawl lcawl merged commit b75b272 into elastic:main Feb 28, 2023
@kibanamachine kibanamachine mentioned this pull request Feb 28, 2023
Merged
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Feb 28, 2023
@lcawl
[DOCS] Add deprecation details to case APIs (elastic#152033)
5305caf 
(cherry picked from commit b75b272)
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
✅ 8.7

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

@lcawl lcawl deleted the case-deprecations branch February 28, 2023 23:14
kibanamachine added a commit that referenced this pull request Mar 1, 2023
@kibanamachine @lcawl
[8.7] [DOCS] Add deprecation details to case APIs (#152033) (#152371)
27923b4 
# Backport

This will backport the following commits from `main` to `8.7`:
- [[DOCS] Add deprecation details to case APIs
(#152033)](#152033)

<!--- Backport version: 8.9.7 -->

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

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2023-02-28T17:17:02Z","message":"[DOCS]
Add deprecation details to case APIs
(#152033)","sha":"b75b272a883a46990f6329044e263704c0e2ebcc","branchLabelMapping":{"^v8.8.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","docs","Feature:Cases","backport:prev-minor","v8.7.0","v8.8.0"],"number":152033,"url":"https://github.com/elastic/kibana/pull/152033","mergeCommit":{"message":"[DOCS]
Add deprecation details to case APIs
(#152033)","sha":"b75b272a883a46990f6329044e263704c0e2ebcc"}},"sourceBranch":"main","suggestedTargetBranches":["8.7"],"targetPullRequestStates":[{"branch":"8.7","label":"v8.7.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.8.0","labelRegex":"^v8.8.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/152033","number":152033,"mergeCommit":{"message":"[DOCS]
Add deprecation details to case APIs
(#152033)","sha":"b75b272a883a46990f6329044e263704c0e2ebcc"}}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
bmorelli25 pushed a commit to bmorelli25/kibana that referenced this pull request Mar 10, 2023
@lcawl @bmorelli25
[DOCS] Add deprecation details to case APIs (elastic#152033)
997838a
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@szabosteve szabosteve szabosteve approved these changes

@jonathan-buttner jonathan-buttner jonathan-buttner approved these changes

@cnasikas cnasikas Awaiting requested review from cnasikas

Assignees
No one assigned
Labels
backport:prev-minor Backport to (9.0) the previous minor version (i.e. one version back from main) docs Feature:Cases Cases feature release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v8.7.0 v8.8.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@lcawl @elasticmachine @kibana-ci @kibanamachine @szabosteve @jonathan-buttner