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] Automate docs for get case APIs #144950

Merged
merged 9 commits into from
Nov 10, 2022
Merged

[DOCS] Automate docs for get case APIs #144950

merged 9 commits into from
Nov 10, 2022

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Nov 9, 2022

Summary

Relates to #137240

This PR uses the open API v3 specification (OAS) to generate output for the following APIs:

  • get case tags
  • get comment
  • get case status
  • get case configuration
  • get cases
  • get case by alert
  • get reporters

It takes output from the open-api generator, in particular the HTML generator, applies a custom template and uses that output in a passthrough block in an appendix in the Kibana Guide.

There were no technical changes required to the specifications in this PR.

@lcawl lcawl added release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) docs Feature:Cases Cases feature v8.6.0 v8.5.1 labels Nov 9, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Nov 9, 2022

Documentation preview:

@lcawl lcawl requested a review from a team November 9, 2022 22:13
@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

Unknown metric groups

ESLint disabled in files

id before after diff
osquery 1 2 +1

ESLint disabled line counts

id before after diff
enterpriseSearch 19 21 +2
fleet 59 65 +6
osquery 108 113 +5
securitySolution 441 447 +6
total +19

Total ESLint disabled count

id before after diff
enterpriseSearch 20 22 +2
fleet 67 73 +6
osquery 109 115 +6
securitySolution 518 524 +6
total +20

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

@lcawl lcawl marked this pull request as ready for review November 9, 2022 23:51
@lcawl lcawl requested a review from a team as a code owner November 9, 2022 23:51
@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

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

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 6804cff into elastic:main Nov 10, 2022
@lcawl lcawl deleted the get-cases branch November 10, 2022 16:27
@kibanamachine
Copy link
Contributor

💔 All backports failed

Status Branch Result
8.5 Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 144950

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit to lcawl/kibana that referenced this pull request Nov 10, 2022
@lcawl
Copy link
Contributor Author

lcawl commented Nov 10, 2022

💚 All backports created successfully

Status Branch Result
8.5

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

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit that referenced this pull request Nov 10, 2022
# Backport

This will backport the following commits from `main` to `8.5`:
- [[DOCS] Automate docs for get case APIs
(#144950)](#144950)

<!--- 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":"2022-11-10T16:27:33Z","message":"[DOCS]
Automate docs for get case APIs
(#144950)","sha":"6804cffc5f73b9ec540932f8d7e2c0f3cee1f97f","branchLabelMapping":{"^v8.6.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","docs","Feature:Cases","v8.6.0","v8.5.1"],"number":144950,"url":"https://github.com/elastic/kibana/pull/144950","mergeCommit":{"message":"[DOCS]
Automate docs for get case APIs
(#144950)","sha":"6804cffc5f73b9ec540932f8d7e2c0f3cee1f97f"}},"sourceBranch":"main","suggestedTargetBranches":["8.5"],"targetPullRequestStates":[{"branch":"main","label":"v8.6.0","labelRegex":"^v8.6.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/144950","number":144950,"mergeCommit":{"message":"[DOCS]
Automate docs for get case APIs
(#144950)","sha":"6804cffc5f73b9ec540932f8d7e2c0f3cee1f97f"}},{"branch":"8.5","label":"v8.5.1","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.5.1 v8.6.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants