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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

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)

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

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 docs release_note:skip Skip the PR/issue when compiling release notes Team:Docs v8.16.2 v8.17.0
Projects
None yet
2 participants