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

[DOCS] Adds GET case activity and GET tags API docs #128874

Merged
merged 5 commits into from
Mar 31, 2022

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented Mar 30, 2022

Summary

Relates to #126956

This PR copies the "get case activity" and "get tags" APIs from the Security Guide to the Kibana Guide. It also formats the content to align with existing Kibana APIs.

Preview

@szabosteve szabosteve added release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting docs Feature:Cases Cases feature APIDocs v8.2.0 v8.3.0 labels Mar 30, 2022
@elasticmachine
Copy link
Contributor

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

@szabosteve szabosteve requested a review from cnasikas March 31, 2022 10:11

=== Request

`GET <kibana host>:<port>/api/cases/<case ID>/user_actions` deprecated:[8.1.0, "This endpoint is deprecated and will be removed in a future release."]
Copy link
Member

@cnasikas cnasikas Mar 31, 2022

Choose a reason for hiding this comment

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

@szabosteve My only concern with having the deprecated warning only on the first endpoint is that a user may think that the GET <kibana host>:<port>/s/<space_id>/api/cases/<case ID>/user_actions is not deprecated. For example this https://kibana_128874.docs-preview.app.elstc.co/guide/en/kibana/master/cases-api-get-status.html has a deprecated warning on the top of the page.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@cnasikas
Ah, okay, that was a misunderstanding on my part. Thanks for clarifying. I moved the deprecation message to the top of the page and added it as a block, not an in-line message.

Copy link
Member

Choose a reason for hiding this comment

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

Thanks!

@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

History

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

@szabosteve szabosteve requested a review from cnasikas March 31, 2022 10:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
APIDocs backport:skip This commit does not require backporting docs Feature:Cases Cases feature release_note:skip Skip the PR/issue when compiling release notes v8.2.0 v8.3.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants