[OpenAPI] Fix Serverless API base URL

lcawl commented 1 week ago

Summary

Fixes https://github.com/elastic/docs-content/issues/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:

The Kibana API examples will look like this:

elasticmachine commented 1 week ago

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

elasticmachine commented 1 week ago

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

github-actions[bot] commented 1 week ago

:robot: 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!)

elasticmachine commented 1 week ago

:yellow_heart: Build succeeded, but was flaky

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

Failed CI Steps

:pipeline::magic_wand: Run Dynamic Pipeline: .buildkite/scripts/pipelines/pull_request/pipeline.sh

Metrics [docs]

✅ unchanged

History

:green_heart: Build #255746 succeeded 756fb8582251990fefdee6b038f383400355cb6c

kibanamachine commented 1 week ago

Starting backport for target branches: 8.16, 8.17

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

kibanamachine commented 1 week ago

💔 All backports failed

Status	Branch	Result
❌	8.16	Backport failed because of merge conflicts You might need to backport the following PRs to 8.16: - [Synthetics] Fix to handle ops genie as default connector !! (#201923) - [Stack Connectors][SentinelOne + Crowdstrike] Update Crowdstrike and Sentinelone connectors to NOT validate API responses (#202515)
❌	8.17	Backport failed because of merge conflicts You might need to backport the following PRs to 8.17: - [Synthetics] Fix to handle ops genie as default connector !! (#201923) - [Stack Connectors][SentinelOne + Crowdstrike] Update Crowdstrike and Sentinelone connectors to NOT validate API responses (#202515) - [Security solution] Remove legacy ESQL quick prompt (#201276) - [Security Solution] [Onboarding] t1_analyst role blocked from interacting with cards due to missing integration privileges (#202413)