-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
[OAS][DOCS] Add temporary overlays for Kibana API documents #189322
Conversation
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
Pinging @elastic/kibana-docs (Team:Docs) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work @lcawl
💚 Build Succeeded
Metrics [docs]
History
To update your PR or re-run it, just comment with: |
💔 All backports failed
Manual backportTo create the backport manually run:
Questions ?Please refer to the Backport tool documentation |
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
…189322) (#189734) # Backport This will backport the following commits from `main` to `8.15`: - [[OAS][DOCS] Add temporary overlays for Kibana API documents (#189322)](#189322) <!--- Backport version: 8.9.8 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Lisa Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-08-01T16:38:01Z","message":"[OAS][DOCS] Add temporary overlays for Kibana API documents (#189322)","sha":"176a2210d769ff004cb0669e002f69099febbec3","branchLabelMapping":{"^v8.16.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","docs","backport:prev-minor","Feature:OAS","v8.16.0"],"number":189322,"url":"https://github.com/elastic/kibana/pull/189322","mergeCommit":{"message":"[OAS][DOCS] Add temporary overlays for Kibana API documents (#189322)","sha":"176a2210d769ff004cb0669e002f69099febbec3"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.16.0","labelRegex":"^v8.16.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/189322","number":189322,"mergeCommit":{"message":"[OAS][DOCS] Add temporary overlays for Kibana API documents (#189322)","sha":"176a2210d769ff004cb0669e002f69099febbec3"}}]}] BACKPORT-->
Summary
This PR adds some overlays to work-around the following issues:
Redundant(fixed in [OAS][DOCS] Deprecate saved object APIs #189223)/s/
paths for saved objectsInternal paths in SLO APIs(fixed in [OAS][DOCS] Remove some SLO APIs from OpenAPI documents #189323)The makefile is also updated to (1) omit the SLO APIs from the stateful Kibana APIs, (2) make the
make api-docs-lint
command also lint the output from themake api-docs-overlay
command.