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

[HTTP] Make case APIs public #184074

Merged
merged 5 commits into from
May 29, 2024
Merged

[HTTP] Make case APIs public #184074

merged 5 commits into from
May 29, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented May 23, 2024

Summary

Relates to #180056, #137240

This PR mirrors #183945 to make the same changes for the case APIs.

NOTE: The openAPI output currently contains the following endpoint for which we don't have docs:
/api/cases/{case_id}/resolve. It seems related to #110854. TBD whether it ought to be included in the public docs

How to test

Per #181277:

  1. Start Elasticsearch (e.g. yarn es snapshot --license trial)
  2. Add server.oas.enabled: true to kibana.dev.yml
  3. Start Kibana (e.g. yarn start --no-base-path)
  4. curl -s -uelastic:changeme http://localhost:5601/api/oas\?pathStartsWith\=/api/cases | jq > test.json

The output will contain summaries like this:

  "paths": {
    "/api/cases": {
      "delete": {
        "summary": "Delete a case",
        "requestBody": {

@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.15.0 labels May 23, 2024
@apmmachine
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@lcawl lcawl marked this pull request as ready for review May 23, 2024 15:22
@lcawl lcawl requested a review from a team as a code owner May 23, 2024 15:22
@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

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

Copy link
Member

@cnasikas cnasikas left a comment

Choose a reason for hiding this comment

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

LGTM! I left some comments.

@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

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

@lcawl lcawl merged commit f31e52a into elastic:main May 29, 2024
19 checks passed
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label May 29, 2024
@lcawl lcawl deleted the case-descriptions branch May 29, 2024 20:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting 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.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants