Skip to content

Conversation

@lcawl
Copy link
Contributor

@lcawl lcawl commented Oct 30, 2025

Summary

Fixes #233419

This PR addresses the remaining response description errors returned from node ./scripts/validate_oas_docs.js:

   │      /paths/~1api~1spaces~1_copy_saved_objects/post/responses/200
   │      must have required property 'description'
   │      Failed check @ schema path: #/required
   |
   │      /paths/~1api~1spaces~1_resolve_copy_saved_objects_errors/post/responses/200
   │      must have required property 'description'
   │      Failed check @ schema path: #/required
   │
   │      /paths/~1api~1spaces~1_update_objects_spaces/post/responses/200
   │      must have required property 'description'
   │      Failed check @ schema path: #/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
- [ ] Review the backport guidelines and apply applicable backport:* labels.

Identify risks

N/A

@lcawl lcawl added Team:Docs release_note:skip Skip the PR/issue when compiling release notes docs backport:version Backport to applied version labels v9.2.0 v9.3.0 labels Oct 30, 2025
@lcawl lcawl marked this pull request as ready for review October 30, 2025 20:13
@lcawl lcawl requested a review from a team as a code owner October 30, 2025 20:13
@elasticmachine
Copy link
Contributor

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

…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 20:29
@lcawl lcawl enabled auto-merge (squash) November 3, 2025 16:11
kibanamachine and others added 5 commits November 3, 2025 16:24
…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
…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 0d039ab into elastic:main Nov 3, 2025
12 checks passed
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 9.2

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

@elasticmachine
Copy link
Contributor

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] FTR Configs #110 / Agents fleet_list_agent should return metrics if available and called with withMetrics
  • [job] [logs] FTR Configs #35 / dashboard app - group 4 dashboard time dashboard with stored timed sets time on open

Metrics [docs]

✅ unchanged

History

@lcawl lcawl deleted the oas-saved-object-responses branch November 4, 2025 00:10
lcawl added a commit to lcawl/kibana that referenced this pull request Nov 4, 2025
Co-authored-by: florent-leborgne <[email protected]>
(cherry picked from commit 0d039ab)
@lcawl
Copy link
Contributor Author

lcawl commented Nov 4, 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
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
…241721)

# Backport

This will backport the following commits from `main` to `9.2`:
- [[DOCS] Add a description for saved object responses
(#241332)](#241332)

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

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

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-11-03T23:14:26Z","message":"[DOCS]
Add a description for saved object responses
(#241332)\n\n\nCo-authored-by: florent-leborgne
<[email protected]>","sha":"0d039abe7df9ebf94ecb4f957689bf0d7b4e8b50","branchLabelMapping":{"^v9.3.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","docs","backport:version","v9.2.0","v9.3.0"],"title":"[DOCS]
Add a description for saved object
responses","number":241332,"url":"https://github.com/elastic/kibana/pull/241332","mergeCommit":{"message":"[DOCS]
Add a description for saved object responses
(#241332)\n\n\nCo-authored-by: florent-leborgne
<[email protected]>","sha":"0d039abe7df9ebf94ecb4f957689bf0d7b4e8b50"}},"sourceBranch":"main","suggestedTargetBranches":["9.2"],"targetPullRequestStates":[{"branch":"9.2","label":"v9.2.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.3.0","branchLabelMappingKey":"^v9.3.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/241332","number":241332,"mergeCommit":{"message":"[DOCS]
Add a description for saved object responses
(#241332)\n\n\nCo-authored-by: florent-leborgne
<[email protected]>","sha":"0d039abe7df9ebf94ecb4f957689bf0d7b4e8b50"}}]}]
BACKPORT-->

---------

Co-authored-by: florent-leborgne <[email protected]>
Co-authored-by: kibanamachine <[email protected]>
@kibanamachine kibanamachine added v9.2.1 and removed backport missing Added to PRs automatically when the are determined to be missing a backport. labels 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 release_note:skip Skip the PR/issue when compiling release notes Team:Docs v9.2.0 v9.2.1 v9.3.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[OAS] Add a description for each response

5 participants