Skip to content

[OAS] Promote space path on serverless APIs#241203

Merged
lcawl merged 7 commits intoelastic:mainfrom
lcawl:serverless-spaces
Nov 3, 2025
Merged

[OAS] Promote space path on serverless APIs#241203
lcawl merged 7 commits intoelastic:mainfrom
lcawl:serverless-spaces

Conversation

@lcawl
Copy link
Copy Markdown
Contributor

@lcawl lcawl commented Oct 29, 2025

Summary

This PR reverts #230931 so that space details are re-added to the Kibana Serverless APIs.
It also updates the overlays so that https://www.elastic.co/docs/api/doc/kibana/topic/topic-kibana-spaces appears in the Kibana Serverless API docs too.

Screenshots

The new "Kibana Spaces" topic in the Kibana Serverless APIs:

image

NOTE: I changed it to use "KIBANA_URL" rather than "localhost:5601" so the same content can be used in both sets of APIs.

Each API now also has the space variation details, for example:

image

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
- [ ] Review the backport guidelines and apply applicable backport:* labels.

Identify risks

N/A

@lcawl lcawl added release_note:skip Skip the PR/issue when compiling release notes docs Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS backport:version Backport to applied version labels v9.2.1 labels Oct 29, 2025
@lcawl lcawl marked this pull request as ready for review October 30, 2025 16:39
@lcawl lcawl requested a review from a team as a code owner October 30, 2025 16:39
@lcawl lcawl added the v9.3.0 label Oct 30, 2025
…atus --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/streams --include-path /api/fleet --include-path /api/saved_objects/_import --include-path /api/saved_objects/_export --include-path /api/maintenance_window --include-path /api/agent_builder --update
@elastic-vault-github-plugin-prod elastic-vault-github-plugin-prod bot requested a review from a team as a code owner October 30, 2025 16:50
@elasticmachine
Copy link
Copy Markdown
Contributor

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] FTR Configs #53 / Agents fleet_agents_status should return incoming data status for specified agents

Metrics [docs]

✅ unchanged

Copy link
Copy Markdown
Member

@florent-leborgne florent-leborgne left a comment

Choose a reason for hiding this comment

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

Nice!

@lcawl lcawl enabled auto-merge (squash) November 3, 2025 16:31
…atus --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/streams --include-path /api/fleet --include-path /api/saved_objects/_import --include-path /api/saved_objects/_export --include-path /api/maintenance_window --include-path /api/agent_builder --update
@lcawl lcawl merged commit d72994b into elastic:main Nov 3, 2025
12 checks passed
@kibanamachine
Copy link
Copy Markdown
Contributor

Starting backport for target branches: 9.2

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

@lcawl lcawl deleted the serverless-spaces branch November 3, 2025 18:33
@kibanamachine
Copy link
Copy Markdown
Contributor

💔 All backports failed

Status Branch Result
9.2 Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 241203

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit to lcawl/kibana that referenced this pull request Nov 3, 2025
@lcawl
Copy link
Copy Markdown
Contributor Author

lcawl commented Nov 3, 2025

💚 All backports created successfully

Status Branch Result
9.2

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

Questions ?

Please refer to the Backport tool documentation

@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Nov 5, 2025
@kibanamachine
Copy link
Copy Markdown
Contributor

Looks like this PR has a backport PR but it still hasn't been merged. Please merge it ASAP to keep the branches relatively in sync.
cc: @lcawl

lcawl added a commit that referenced this pull request Nov 6, 2025
# Backport

This will backport the following commits from `main` to `9.2`:
- [[OAS] Promote space path on serverless APIs
(#241203)](#241203)

<!--- Backport version: 10.1.0 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2025-11-03T18:31:20Z","message":"[OAS]
Promote space path on serverless APIs
(#241203)","sha":"d72994bd60d6464748de2b456d40a1d0da11dcd9","branchLabelMapping":{"^v9.3.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","docs","Feature:OAS","backport:version","v9.3.0","v9.2.1"],"title":"[OAS]
Promote space path on serverless
APIs","number":241203,"url":"https://github.com/elastic/kibana/pull/241203","mergeCommit":{"message":"[OAS]
Promote space path on serverless APIs
(#241203)","sha":"d72994bd60d6464748de2b456d40a1d0da11dcd9"}},"sourceBranch":"main","suggestedTargetBranches":["9.2"],"targetPullRequestStates":[{"branch":"main","label":"v9.3.0","branchLabelMappingKey":"^v9.3.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/241203","number":241203,"mergeCommit":{"message":"[OAS]
Promote space path on serverless APIs
(#241203)","sha":"d72994bd60d6464748de2b456d40a1d0da11dcd9"}},{"branch":"9.2","label":"v9.2.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->
@kibanamachine kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Nov 6, 2025
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 Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS release_note:skip Skip the PR/issue when compiling release notes v9.2.1 v9.3.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants