[ResponseOps][MW] Maintenance Window oas documentation #212377
Merged
Conversation
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
lcawl
approved these changes
Feb 25, 2025
jbudz
approved these changes
Feb 26, 2025
adcoelho
changed the title
- Added route tags - Small text changes
|
@lcawl I had to rebase this PR, could you please take another look? All routes are inside |
…t --include-path /api/status --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/dashboards --include-path /api/alerting/maintenance_window --update --no-serverless'
…t --include-path /api/status --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/dashboards --include-path /api/alerting/maintenance_window --update --no-serverless'
Here's a suggestion for changes to the
|
💔 Build Failed
Failed CI Steps
Test Failures
Metrics [docs]
History
|
cnasikas
reviewed
Apr 15, 2025
| For example, a maintenance window prevents false alarms during planned outages. | ||
| externalDocs: | ||
| description: Maintenance window documentation | ||
| url: https://www.elastic.co/docs/explore-analyze/alerts-cases/alerts/maintenance-windows |
There was a problem hiding this comment.
Should we have a dedicated URL outside alerts? Like https://www.elastic.co/docs/explore-analyze/maintenance-windows. I am not sure, tbh what this URL is about 🙂.
cnasikas
reviewed
Apr 15, 2025
| @@ -53,6 +53,7 @@ export const createMaintenanceWindowRoute = ( | |||
| options: { | |||
| access: 'public', | |||
| summary: 'Create a maintenance window.', | |||
| tags: ['oas-tag:alerting'], | |||
There was a problem hiding this comment.
I am sure you are aware, but a note to not forget to resolve the conflicts with the public APIs PR where we changed the tags.
adcoelho
changed the title
…t --include-path /api/status --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/dashboards --include-path /api/saved_objects/_import --include-path /api/saved_objects/_export --include-path /api/alerting/maintenance_window --update --no-serverless'
adcoelho
added a commit
that referenced
this pull request
Apr 16, 2025
Closes #198685 ## Summary This PR creates a public Maintenance Window API. The work was done on a feature branch over multiple separate PRs. Here we will merge the feature branch into `main`. - #209734 - #213694 - #214747 - #213771 The [documentation PR](#212377) still needs to be merged. ## Release Notes Publish new public APIs for the Maintenance Window. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: lcawl <lcawley@elastic.co>
adcoelho
added a commit
to adcoelho/kibana
that referenced
this pull request
Apr 17, 2025
…ic#216756) Closes elastic#198685 ## Summary This PR creates a public Maintenance Window API. The work was done on a feature branch over multiple separate PRs. Here we will merge the feature branch into `main`. - elastic#209734 - elastic#213694 - elastic#214747 - elastic#213771 The [documentation PR](elastic#212377) still needs to be merged. ## Release Notes Publish new public APIs for the Maintenance Window. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: lcawl <lcawley@elastic.co> (cherry picked from commit 08d0717) # Conflicts: # .buildkite/scripts/steps/checks/capture_oas_snapshot.sh # oas_docs/overlays/kibana.overlays.shared.yaml
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Merging into a feature branch
Summary
I recently added a few public routes for managing maintenance windows. I will need to generate documentation for these routes for my' on week' task.
capture_oas_snapshotto include/api/alerting/maintenance_windowtagsto the maintenance window routes