[Fleet] Fix Fleet OAS errors#265831
Merged
criamico merged 9 commits intoelastic:mainfrom Apr 28, 2026
Merged
Conversation
criamico
added
Team:Fleet
Contributor
|
Pinging @elastic/fleet (Team:Fleet) |
Contributor
ApprovabilityVerdict: Would Approve Documentation-only changes adding description metadata to Fleet API schema definitions for OpenAPI spec generation. No runtime behavior is modified - this purely fixes OAS validation errors by adding missing parameter descriptions. Macroscope would have approved this PR. A repo admin can enable approvability here. |
elastic-vault-github-plugin-prod
Bot
requested a review
from a team
as a code owner
vishaangelova
approved these changes
Apr 28, 2026
Member
vishaangelova
left a comment
vishaangelova
left a comment
There was a problem hiding this comment.
Just a couple of very minor suggestions. LGTM.
Contributor
💛 Build succeeded, but was flaky
Failed CI StepsMetrics [docs]
History
cc @criamico |
Contributor
|
Starting backport for target branches: 9.4 https://github.com/elastic/kibana/actions/runs/25051507548 |
Contributor
💔 All backports failed
Manual backportTo create the backport manually run: Questions ?Please refer to the Backport tool documentation |
Member
Author
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
criamico
added a commit
that referenced
this pull request
Apr 28, 2026
# Backport This will backport the following commits from `main` to `9.4`: - [[Fleet] Fix Fleet OAS errors (#265831)](#265831) <!--- Backport version: 11.0.2 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Cristina Amico","email":"criamico@users.noreply.github.com"},"sourceCommit":{"committedDate":"2026-04-28T11:59:32Z","message":"[Fleet] Fix Fleet OAS errors (#265831)\n\nRelated to https://github.com/elastic/kibana/issues/259777\n\n## Summary\nAfter the merge of the PRs listed in\nhttps://github.com//issues/259777, there were still many\noutstanding errors in Fleet OAS docs - mostly due to missing\ndescriptions in schemas. This PR fixes those errors in one pass.\nI locally generated the errors with ` node\n./scripts/validate_oas_docs.js`.\n\n- Adds missing description metadata to Fleet API query and path\nparameters across all Fleet REST spec schema files. Without these\ndescriptions, the OAS validator reports errors for each undescribed\nparameter.\n- Also adds application/gzip; application/zip example blocks to the\npackage upload endpoint YAML (`post_install_package_by_upload.yaml`) to\nfix 6 missing-examples validation errors.\n\n### Validation\n- `yarn kbn bootstrap`\n- Run \n```\n- node scripts/capture_oas_snapshot \\\n --include-path /api/fleet\n```\n- `cd oas_docs && make api-docs`\n- Go back on kibana root folder and run ` node\nscripts/validate_oas_docs.js`\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"bcedd4dd0b43bfeca10311afe2a41db47fcce6a4","branchLabelMapping":{"^v9.5.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:Fleet","backport:version","v9.4.0","v9.5.0"],"title":"[Fleet] Fix Fleet OAS errors","number":265831,"url":"https://github.com/elastic/kibana/pull/265831","mergeCommit":{"message":"[Fleet] Fix Fleet OAS errors (#265831)\n\nRelated to https://github.com/elastic/kibana/issues/259777\n\n## Summary\nAfter the merge of the PRs listed in\nhttps://github.com//issues/259777, there were still many\noutstanding errors in Fleet OAS docs - mostly due to missing\ndescriptions in schemas. This PR fixes those errors in one pass.\nI locally generated the errors with ` node\n./scripts/validate_oas_docs.js`.\n\n- Adds missing description metadata to Fleet API query and path\nparameters across all Fleet REST spec schema files. Without these\ndescriptions, the OAS validator reports errors for each undescribed\nparameter.\n- Also adds application/gzip; application/zip example blocks to the\npackage upload endpoint YAML (`post_install_package_by_upload.yaml`) to\nfix 6 missing-examples validation errors.\n\n### Validation\n- `yarn kbn bootstrap`\n- Run \n```\n- node scripts/capture_oas_snapshot \\\n --include-path /api/fleet\n```\n- `cd oas_docs && make api-docs`\n- Go back on kibana root folder and run ` node\nscripts/validate_oas_docs.js`\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"bcedd4dd0b43bfeca10311afe2a41db47fcce6a4"}},"sourceBranch":"main","suggestedTargetBranches":["9.4"],"targetPullRequestStates":[{"branch":"9.4","label":"v9.4.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.5.0","branchLabelMappingKey":"^v9.5.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/265831","number":265831,"mergeCommit":{"message":"[Fleet] Fix Fleet OAS errors (#265831)\n\nRelated to https://github.com/elastic/kibana/issues/259777\n\n## Summary\nAfter the merge of the PRs listed in\nhttps://github.com//issues/259777, there were still many\noutstanding errors in Fleet OAS docs - mostly due to missing\ndescriptions in schemas. This PR fixes those errors in one pass.\nI locally generated the errors with ` node\n./scripts/validate_oas_docs.js`.\n\n- Adds missing description metadata to Fleet API query and path\nparameters across all Fleet REST spec schema files. Without these\ndescriptions, the OAS validator reports errors for each undescribed\nparameter.\n- Also adds application/gzip; application/zip example blocks to the\npackage upload endpoint YAML (`post_install_package_by_upload.yaml`) to\nfix 6 missing-examples validation errors.\n\n### Validation\n- `yarn kbn bootstrap`\n- Run \n```\n- node scripts/capture_oas_snapshot \\\n --include-path /api/fleet\n```\n- `cd oas_docs && make api-docs`\n- Go back on kibana root folder and run ` node\nscripts/validate_oas_docs.js`\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"bcedd4dd0b43bfeca10311afe2a41db47fcce6a4"}}]}] BACKPORT-->
smith
pushed a commit
to smith/kibana
that referenced
this pull request
Apr 28, 2026
Related to elastic#259777 ## Summary After the merge of the PRs listed in elastic#259777, there were still many outstanding errors in Fleet OAS docs - mostly due to missing descriptions in schemas. This PR fixes those errors in one pass. I locally generated the errors with ` node ./scripts/validate_oas_docs.js`. - Adds missing description metadata to Fleet API query and path parameters across all Fleet REST spec schema files. Without these descriptions, the OAS validator reports errors for each undescribed parameter. - Also adds application/gzip; application/zip example blocks to the package upload endpoint YAML (`post_install_package_by_upload.yaml`) to fix 6 missing-examples validation errors. ### Validation - `yarn kbn bootstrap` - Run ``` - node scripts/capture_oas_snapshot \ --include-path /api/fleet ``` - `cd oas_docs && make api-docs` - Go back on kibana root folder and run ` node scripts/validate_oas_docs.js` --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related to #259777
Summary
After the merge of the PRs listed in #259777, there were still many outstanding errors in Fleet OAS docs - mostly due to missing descriptions in schemas. This PR fixes those errors in one pass.
I locally generated the errors with
node ./scripts/validate_oas_docs.js.post_install_package_by_upload.yaml) to fix 6 missing-examples validation errors.Validation
yarn kbn bootstrapcd oas_docs && make api-docsnode scripts/validate_oas_docs.js