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][OAS] Add cases to Kibana API bundle #189020

Merged
merged 9 commits into from
Jul 30, 2024
Merged

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jul 24, 2024

Summary

This PR:

  • reverts [OAS] Migrate case APIs to v3.1.0  #171593 so that the cases openAPI document can be joined with the other documents in oas_docs
  • cleans up the operation summaries as suggested by the linting rules
  • adds the deprecated property per [HTTP/OAS] Support deprecated field #181240
  • removes the /s/ version of the paths from the openAPI document, since per discussions elsewhere we'll cover that in an introductory page rather than repeat for every endpoint

@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 backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS labels Jul 24, 2024
@obltmachine
Copy link

🤖 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 changed the title [DOCS][OAS] Revert cases OAS version to 3.0 [DOCS][OAS] Add cases to Kibana API bundle Jul 26, 2024
@lcawl lcawl marked this pull request as ready for review July 26, 2024 16:10
@lcawl lcawl requested review from a team as code owners July 26, 2024 16:10
@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

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

@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

✅ unchanged

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

Copy link
Contributor

@karenzone karenzone 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 d86e139 into elastic:main Jul 30, 2024
21 checks passed
@lcawl lcawl deleted the case-api-join branch July 30, 2024 14:49
@kibanamachine
Copy link
Contributor

💔 All backports failed

Status Branch Result
8.15 Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 189020

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit to lcawl/kibana that referenced this pull request Jul 30, 2024
@lcawl
Copy link
Contributor Author

lcawl commented Jul 30, 2024

💚 All backports created successfully

Status Branch Result
8.15

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

Questions ?

Please refer to the Backport tool documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) docs Feature:Cases Cases feature Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS 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 v8.16.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants