Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[OpenAPI][Fleet] Add missing operation summaries #199548

Merged
merged 2 commits into from
Nov 8, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Nov 8, 2024

Summary

This PR addresses the following type of linting messages that are occurring for the Fleet APIs:

18769:16      warning  operation-summary-length    Operation summary should be between 5 and 45 characters                           paths./api/fleet/agents.get.summary
 18834:16      warning  operation-summary-length    Operation summary should be between 5 and 45 characters                           paths./api/fleet/agents.post.summary
 18892:16      warning  operation-summary-length    Operation summary should be between 5 and 45 characters                           paths./api/fleet/agents/{agentId}.delete.summary

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.

@lcawl lcawl added release_note:skip Skip the PR/issue when compiling release notes Team:Fleet Team label for Observability Data Collection Fleet team docs v8.16.0 backport:version Backport to applied version labels v8.17.0 labels Nov 8, 2024
@lcawl lcawl requested a review from a team as a code owner November 8, 2024 20:06
@elasticmachine
Copy link
Contributor

Pinging @elastic/fleet (Team:Fleet)

Copy link
Member

@nchaulet nchaulet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚀

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

@lcawl lcawl merged commit ef0428f into elastic:main Nov 8, 2024
36 checks passed
@lcawl lcawl deleted the fleet-api-summaries branch November 8, 2024 22:13
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 8.16, 8.x

https://github.com/elastic/kibana/actions/runs/11750313837

@kibanamachine
Copy link
Contributor

💔 All backports failed

Status Branch Result
8.16 Backport failed because of merge conflicts

You might need to backport the following PRs to 8.16:
- [DOCS][OpenAPI] Change x-technical-preview to x-state in case APIs (#195325)
8.x Backport failed because of merge conflicts

You might need to backport the following PRs to 8.x:
- Changes deprecated SO HTTP APIs deprecation field to object (#197936)
- [DOCS][OpenAPI] Change x-technical-preview to x-state in case APIs (#195325)

Manual backport

To create the backport manually run:

node scripts/backport --pr 199548

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit to lcawl/kibana that referenced this pull request Nov 8, 2024
lcawl added a commit to lcawl/kibana that referenced this pull request Nov 8, 2024
@lcawl
Copy link
Contributor Author

lcawl commented Nov 8, 2024

💚 All backports created successfully

Status Branch Result
8.x
8.16

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

@kibanamachine
Copy link
Contributor

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]>
@kibanamachine
Copy link
Contributor

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.

@kibanamachine
Copy link
Contributor

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 kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Nov 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:version Backport to applied version labels docs release_note:skip Skip the PR/issue when compiling release notes Team:Fleet Team label for Observability Data Collection Fleet team v8.16.0 v8.17.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants