Skip to content

[ResponseOps][OAS] add examples and descriptions for Maintenance Window apis#260943

Draft
georgianaonoleata1904 wants to merge 2 commits intoelastic:mainfrom
georgianaonoleata1904:api-mw-examples
Draft

[ResponseOps][OAS] add examples and descriptions for Maintenance Window apis#260943
georgianaonoleata1904 wants to merge 2 commits intoelastic:mainfrom
georgianaonoleata1904:api-mw-examples

Conversation

@georgianaonoleata1904
Copy link
Copy Markdown
Contributor

@georgianaonoleata1904 georgianaonoleata1904 commented Apr 2, 2026

Closes https://github.com/elastic/kibana-team/issues/3153

Summary

  • Added OAS request/response examples for all public maintenance window API routes (create, get, update, find, archive, unarchive). Skipped delete route as it has no request body and returns 204 No Content (no examples to document)
  • wired oasOperationObject into each route to include examples in the generated specs
  • added missing meta.description for schema fields in find response (page, per_page, total, maintenanceWindows), update request params (id), and shared schema (maintenanceWindowCategoryIdsSchema)

@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Apr 2, 2026

🤖 Jobs for this PR can be triggered through checkboxes. 🚧

ℹ️ To trigger the CI, please tick the checkbox below 👇

  • Click to trigger kibana-pull-request for this PR!
  • Click to trigger kibana-deploy-project-from-pr for this PR!
  • Click to trigger kibana-deploy-cloud-from-pr for this PR!
  • Click to trigger kibana-entity-store-performance-from-pr for this PR!
  • Click to trigger kibana-storybooks-from-pr for this PR!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants