-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Fleet] Fix Fleet OpenAPI errors (#150583)
## Summary Fixes #149990 There's still plenty of warnings to clean up, and I think we should file a separate issue to follow up on them. Missing descriptions, empty tags, etc are things we can certainly clean up ahead of the API being labeled as GA, they'll just be a little time consuming to track down. The goal of this PR is simply to remove the `error` level output from the linters as specified in the linked issue. ## To test I've added some convenience scripts in `x-pack/plugins/fleet/package.json` to make working with the OpenAPI spec easier. You can view the lint output of the built `bundled.yaml` or `bundled.json` file by running the following: ``` $ # From Kibana root $ cd x-pack/plugins/fleet # Runs redocly linter $ yarn openapi:lint # Runs speccy $ yarn openapi:speccy ``` If you need to rebuild the `bundled` spec files, there's a script now as well: ``` $ yarn openapi:build ``` Redocly reports 89 warnings and no errors, which should suffice in resolving the linked issue. cc @lcawl Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
- Loading branch information
1 parent
3b6ae1c
commit d0b0985
Showing
6 changed files
with
34 additions
and
3 deletions.
There are no files selected for viewing
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -22,6 +22,8 @@ get: | |
parameters: | ||
- schema: | ||
type: array | ||
items: | ||
type: string | ||
name: agentsIds | ||
in: query | ||
required: true |
5 changes: 5 additions & 0 deletions
5
x-pack/plugins/fleet/common/openapi/paths/agents@{agent_id}@actions@{action_id}@cancel.yaml
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,9 @@ | ||
parameters: | ||
- schema: | ||
type: string | ||
name: agentId | ||
in: path | ||
required: true | ||
- schema: | ||
type: string | ||
name: actionId | ||
|
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