-
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
[OpenAPI] Fix Serverless API base URL #202373
Conversation
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
Pinging @elastic/obs-ux-management-team (Team:obs-ux-management) |
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
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! 🦓
💛 Build succeeded, but was flaky
Failed CI StepsMetrics [docs]
History
|
Starting backport for target branches: 8.16, 8.17 |
(cherry picked from commit 54370b2)
(cherry picked from commit 54370b2)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
(cherry picked from commit 54370b2)
# Backport This will backport the following commits from `main` to `8.17`: - [[OpenAPI] Fix Serverless API base URL (#202373)](#202373) <!--- 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-12-02T20:09:03Z","message":"[OpenAPI] Fix Serverless API base URL (#202373)","sha":"54370b209cb8f4fe02186355f69b8d2f4e4bc97e","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","v9.0.0","docs","ci:project-deploy-observability","Team:obs-ux-management","backport:version","v8.17.0","v8.18.0","v8.16.2"],"number":202373,"url":"https://github.com/elastic/kibana/pull/202373","mergeCommit":{"message":"[OpenAPI] Fix Serverless API base URL (#202373)","sha":"54370b209cb8f4fe02186355f69b8d2f4e4bc97e"}},"sourceBranch":"main","suggestedTargetBranches":["8.17","8.x","8.16"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/202373","number":202373,"mergeCommit":{"message":"[OpenAPI] Fix Serverless API base URL (#202373)","sha":"54370b209cb8f4fe02186355f69b8d2f4e4bc97e"}},{"branch":"8.17","label":"v8.17.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.18.0","labelRegex":"^v8.18.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.16","label":"v8.16.2","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT-->
# Backport This will backport the following commits from `main` to `8.16`: - [[OpenAPI] Fix Serverless API base URL (#202373)](#202373) <!--- 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-12-02T20:09:03Z","message":"[OpenAPI] Fix Serverless API base URL (#202373)","sha":"54370b209cb8f4fe02186355f69b8d2f4e4bc97e","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","v9.0.0","docs","ci:project-deploy-observability","Team:obs-ux-management","backport:version","v8.17.0","v8.18.0","v8.16.2"],"number":202373,"url":"https://github.com/elastic/kibana/pull/202373","mergeCommit":{"message":"[OpenAPI] Fix Serverless API base URL (#202373)","sha":"54370b209cb8f4fe02186355f69b8d2f4e4bc97e"}},"sourceBranch":"main","suggestedTargetBranches":["8.17","8.x","8.16"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/202373","number":202373,"mergeCommit":{"message":"[OpenAPI] Fix Serverless API base URL (#202373)","sha":"54370b209cb8f4fe02186355f69b8d2f4e4bc97e"}},{"branch":"8.17","label":"v8.17.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.18.0","labelRegex":"^v8.18.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.16","label":"v8.16.2","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT-->
Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync. |
# Backport This will backport the following commits from `main` to `8.x`: - [[OpenAPI] Fix Serverless API base URL (#202373)](#202373) <!--- 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-12-02T20:09:03Z","message":"[OpenAPI] Fix Serverless API base URL (#202373)","sha":"54370b209cb8f4fe02186355f69b8d2f4e4bc97e","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","v9.0.0","docs","ci:project-deploy-observability","Team:obs-ux-management","backport:version","v8.17.0","v8.18.0","v8.16.2"],"number":202373,"url":"https://github.com/elastic/kibana/pull/202373","mergeCommit":{"message":"[OpenAPI] Fix Serverless API base URL (#202373)","sha":"54370b209cb8f4fe02186355f69b8d2f4e4bc97e"}},"sourceBranch":"main","suggestedTargetBranches":["8.17","8.x","8.16"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/202373","number":202373,"mergeCommit":{"message":"[OpenAPI] Fix Serverless API base URL (#202373)","sha":"54370b209cb8f4fe02186355f69b8d2f4e4bc97e"}},{"branch":"8.17","label":"v8.17.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.18.0","labelRegex":"^v8.18.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.16","label":"v8.16.2","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Dominique Clarke <[email protected]>
Summary
Fixes elastic/docs-content#153
In particular, it removes unnecessary server URL declarations from some SLO API files and updates the kibana API overlays so that the serverless API document is no longer referring to "localhost".
NOTE: Per https://spec.openapis.org/oas/v3.0.3#server-object the "default" value is required.
Checklist
Check the PR satisfies following conditions.
Reviewers should verify this PR satisfies this list as well.
release_note:breaking
label should be applied in these situations.release_note:*
label is applied per the guidelinesIdentify risks
Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss.
No
Screenshots
The Kibana Serverless API examples will look like this:
The Kibana API examples will look like this: