[OpenAPI][Fleet] Add missing operation summaries #199548
Merged
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
release_note:skip
|
Pinging @elastic/fleet (Team:Fleet) |
💚 Build Succeeded
Metrics [docs]
|
|
Starting backport for target branches: 8.16, 8.x |
💔 All backports failed
Manual backportTo create the backport manually run: Questions ?Please refer to the Backport tool documentation |
lcawl
added a commit
to lcawl/kibana
that referenced
this pull request
Nov 8, 2024
(cherry picked from commit ef0428f)
lcawl
added a commit
to lcawl/kibana
that referenced
this pull request
Nov 8, 2024
(cherry picked from commit ef0428f)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
CAWilson94
pushed a commit
to CAWilson94/kibana
that referenced
this pull request
Nov 11, 2024
This was referenced Nov 11, 2024
kibanamachine
added
the
backport missing
|
Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync. |
lcawl
added a commit
that referenced
this pull request
Nov 12, 2024
…99570) # Backport This will backport the following commits from `main` to `8.16`: - [[OpenAPI][Fleet] Add missing operation summaries (#199548)](#199548) <!--- Backport version: 8.9.8 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Lisa Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-11-08T22:13:10Z","message":"[OpenAPI][Fleet] Add missing operation summaries (#199548)","sha":"ef0428ffec3084777a8ff82c7191f754bad5705f","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:Fleet","v9.0.0","docs","v8.16.0","backport:version","v8.17.0"],"number":199548,"url":"https://github.com/elastic/kibana/pull/199548","mergeCommit":{"message":"[OpenAPI][Fleet] Add missing operation summaries (#199548)","sha":"ef0428ffec3084777a8ff82c7191f754bad5705f"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/199548","number":199548,"mergeCommit":{"message":"[OpenAPI][Fleet] Add missing operation summaries (#199548)","sha":"ef0428ffec3084777a8ff82c7191f754bad5705f"}},{"branch":"8.16","label":"v8.16.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.17.0","labelRegex":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> --------- Co-authored-by: kibanamachine <[email protected]>
|
Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync. |
|
Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync. |
lcawl
added a commit
that referenced
this pull request
Nov 14, 2024
…9569) # Backport This will backport the following commits from `main` to `8.x`: - [[OpenAPI][Fleet] Add missing operation summaries (#199548)](#199548) <!--- Backport version: 8.9.8 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Lisa Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-11-08T22:13:10Z","message":"[OpenAPI][Fleet] Add missing operation summaries (#199548)","sha":"ef0428ffec3084777a8ff82c7191f754bad5705f","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:Fleet","v9.0.0","docs","v8.16.0","backport:version","v8.17.0"],"number":199548,"url":"https://github.com/elastic/kibana/pull/199548","mergeCommit":{"message":"[OpenAPI][Fleet] Add missing operation summaries (#199548)","sha":"ef0428ffec3084777a8ff82c7191f754bad5705f"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/199548","number":199548,"mergeCommit":{"message":"[OpenAPI][Fleet] Add missing operation summaries (#199548)","sha":"ef0428ffec3084777a8ff82c7191f754bad5705f"}},{"branch":"8.16","label":"v8.16.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.17.0","labelRegex":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT-->
kibanamachine
removed
the
backport missing
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 addresses the following type of linting messages that are occurring for the Fleet APIs:
In some cases the summary was missing entirely, in others it was empty.
Operation summaries are mandatory for the purposes of our documentation. They should be concise--at most 30 characters--and start with a verb. We use common verbs like Get, Update, Delete whenever possible.
In most cases I have changed the "description" declaration to a "summary" since the former is optional and only required when there's longer form information that needs to be added to the docs.