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] Omit specs for default spaces and extra tags in case APIs #138779

Merged
merged 6 commits into from
Sep 26, 2022

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Aug 13, 2022

Summary

Relates to #133345

This PR:

  1. Removes the 'kibana' tags from the case open API specifications. The open API specifications for Kibana cases currently include two tags, which results in duplicated documentation in some tools.
  2. Removes the paths that don't include the space ID. There is also duplication due to the fact that most Kibana APIs have an optional s/{spaceId} in the path. Per "Describing parameters" in the Open API Guide, "Note that path parameters must have required: true, because they are always required". Rather than continue to duplicate both versions of the API, per Automated OpenAPI spec generation #82587 (comment) I've removed the endpoints that omit the space specification.
  3. Clarifies the space ID description.

@lcawl lcawl added docs Feature:Cases Cases feature labels Aug 13, 2022
@lcawl lcawl added v8.6.0 v8.5.0 v8.4.3 Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) labels Sep 23, 2022
@lcawl lcawl marked this pull request as ready for review September 23, 2022 18:04
@lcawl lcawl requested a review from a team as a code owner September 23, 2022 18:04
@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 Sep 23, 2022
@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 7a3e3ba into elastic:main Sep 26, 2022
@lcawl lcawl deleted the cases-minimal-spec branch September 26, 2022 18:08
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Sep 26, 2022
@kibanamachine
Copy link
Contributor

💔 Some backports could not be created

Status Branch Result
8.4 Backport failed because of merge conflicts

You might need to backport the following PRs to 8.4:
- Add openAPI specifications for push case API (#137549)
8.5

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

Manual backport

To create the backport manually run:

node scripts/backport --pr 138779

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Sep 26, 2022
lcawl added a commit to lcawl/kibana that referenced this pull request Sep 26, 2022
@lcawl
Copy link
Contributor Author

lcawl commented Sep 26, 2022

💚 All backports created successfully

Status Branch Result
8.4

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 Sep 26, 2022
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.4.3 v8.5.0 v8.6.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants