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

[OpenAPI] Fix Serverless API base URL #202373

Merged
merged 3 commits into from
Dec 2, 2024
Merged

[OpenAPI] Fix Serverless API base URL #202373

merged 3 commits into from
Dec 2, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Nov 30, 2024

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.

  • Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
  • Documentation was added for features that require explanation or tutorials
  • Unit or functional tests were updated or added to match the most common scenarios
  • If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
  • This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The release_note:breaking label should be applied in these situations.
  • Flaky Test Runner was used on any tests changed
  • The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines

Identify 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:

image

The Kibana API examples will look like this:

image

@lcawl lcawl added Team:Docs release_note:skip Skip the PR/issue when compiling release notes docs backport:version Backport to applied version labels v8.17.0 v8.16.2 labels Nov 30, 2024
@lcawl lcawl marked this pull request as ready for review November 30, 2024 00:16
@lcawl lcawl requested review from a team as code owners November 30, 2024 00:16
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

Copy link
Contributor

@dominiqueclarke dominiqueclarke left a comment

Choose a reason for hiding this comment

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

LGTM

@botelastic botelastic bot added ci:project-deploy-observability Create an Observability project Team:obs-ux-management Observability Management User Experience Team labels Dec 2, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/obs-ux-management-team (Team:obs-ux-management)

Copy link
Contributor

github-actions bot commented Dec 2, 2024

🤖 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!)

Copy link
Contributor

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

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

LGTM! 🦓

@elasticmachine
Copy link
Contributor

elasticmachine commented Dec 2, 2024

💛 Build succeeded, but was flaky

  • Buildkite Build
  • Commit: 985d6cd
  • Kibana Serverless Image: docker.elastic.co/kibana-ci/kibana-serverless:pr-202373-985d6cd26be8

Failed CI Steps

Metrics [docs]

✅ unchanged

History

@lcawl lcawl merged commit 54370b2 into elastic:main Dec 2, 2024
8 checks passed
@lcawl lcawl deleted the kibana-apis branch December 2, 2024 20:09
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 8.16, 8.17

https://github.com/elastic/kibana/actions/runs/12127137280

@kibanamachine
Copy link
Contributor

@lcawl lcawl added the v8.18.0 label Dec 2, 2024
lcawl added a commit to lcawl/kibana that referenced this pull request Dec 2, 2024
lcawl added a commit to lcawl/kibana that referenced this pull request Dec 2, 2024
@lcawl
Copy link
Contributor Author

lcawl commented Dec 2, 2024

💚 All backports created successfully

Status Branch Result
8.x
8.17
8.16

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

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit to lcawl/kibana that referenced this pull request Dec 2, 2024
lcawl added a commit that referenced this pull request Dec 3, 2024
# 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-->
lcawl added a commit that referenced this pull request Dec 3, 2024
# 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-->
@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Dec 3, 2024
@kibanamachine
Copy link
Contributor

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.

lcawl added a commit that referenced this pull request Dec 4, 2024
# 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]>
@kibanamachine kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Dec 4, 2024
hop-dev pushed a commit to hop-dev/kibana that referenced this pull request Dec 5, 2024
CAWilson94 pushed a commit to CAWilson94/kibana that referenced this pull request Dec 9, 2024
CAWilson94 pushed a commit to CAWilson94/kibana that referenced this pull request Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:version Backport to applied version labels ci:project-deploy-observability Create an Observability project docs release_note:skip Skip the PR/issue when compiling release notes Team:Docs Team:obs-ux-management Observability Management User Experience Team v8.16.2 v8.17.0 v8.18.0 v9.0.0
Projects
None yet
5 participants