[OpenAPI][ResponseOps] Edit descriptions for alerting rule API examples #194080
Conversation
This file contains 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
added
Feature:Alerting
release_note:skip
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
💚 Build Succeeded
Metrics [docs]
To update your PR or re-run it, just comment with: |
|
Starting backport for target branches: 8.x https://github.com/elastic/kibana/actions/runs/11074492488 |
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Sep 27, 2024
…es (elastic#194080) (cherry picked from commit 539ad61)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
kibanamachine
added a commit
that referenced
this pull request
Sep 27, 2024
…examples (#194080) (#194327) # Backport This will backport the following commits from `main` to `8.x`: - [[OpenAPI][ResponseOps] Edit descriptions for alerting rule API examples (#194080)](#194080) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Lisa Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-09-27T16:45:44Z","message":"[OpenAPI][ResponseOps] Edit descriptions for alerting rule API examples (#194080)","sha":"539ad61d377f8982f3358b1a753be45408c4998c","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Alerting","release_note:skip","v9.0.0","docs","v8.16.0","backport:version"],"title":"[OpenAPI][ResponseOps] Edit descriptions for alerting rule API examples","number":194080,"url":"https://github.com/elastic/kibana/pull/194080","mergeCommit":{"message":"[OpenAPI][ResponseOps] Edit descriptions for alerting rule API examples (#194080)","sha":"539ad61d377f8982f3358b1a753be45408c4998c"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/194080","number":194080,"mergeCommit":{"message":"[OpenAPI][ResponseOps] Edit descriptions for alerting rule API examples (#194080)","sha":"539ad61d377f8982f3358b1a753be45408c4998c"}},{"branch":"8.x","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Lisa Cawley <[email protected]>
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.
Summary
This PR edits the summaries and descriptions for the alerting API examples, since they will now be displayed when we publish the OpenAPI document.
Preview
The
summaryis the menu title when there are multiple examples. Thedescriptionis displayed as commented out text within the body of the request or response example.