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.

Sign up for GitHub

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

Jump to bottom

[Response Ops] Alerting API docs incorrect for fields query param #132137

Closed
ymao1 opened this issue May 12, 2022 · 1 comment · Fixed by #132163
Closed

[Response Ops] Alerting API docs incorrect for fields query param #132137

ymao1 opened this issue May 12, 2022 · 1 comment · Fixed by #132163
Assignees
@lcawl
Labels
bug Fixes for quality problems that affect the customer experience docs Feature:Alerting/RulesFramework Issues related to the Alerting Rules Framework Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)

Comments

@ymao1
Copy link
Contributor

ymao1 commented May 12, 2022

In https://www.elastic.co/guide/en/kibana/master/find-rules-api.html, we document the fields query parameter as accepting array|string. In the code, it only accepts an array

kibana/x-pack/plugins/alerting/server/routes/find_rules.ts

Line 48 in 6871c65

fields: schema.maybe(schema.arrayOf(schema.string())),

We should fix the docs to reflect this. This should be backported as far as we can as the issue was found by someone using the 7.13 docs.
@ymao1 ymao1 added Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) docs Feature:Alerting/RulesFramework Issues related to the Alerting Rules Framework labels May 12, 2022
@elasticmachine
Copy link
Contributor

Pinging @elastic/response-ops (Team:ResponseOps)

@mikecote mikecote added the bug Fixes for quality problems that affect the customer experience label May 12, 2022
@mikecote mikecote moved this from Awaiting Triage to Todo in AppEx: ResponseOps - Execution & Connectors May 12, 2022
@lcawl lcawl self-assigned this May 12, 2022
@mikecote mikecote moved this from Todo to In Progress in AppEx: ResponseOps - Execution & Connectors May 12, 2022
@lcawl lcawl mentioned this issue May 12, 2022
Merged
Repository owner moved this from In Progress to Done in AppEx: ResponseOps - Execution & Connectors May 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lcawl lcawl

Labels
bug Fixes for quality problems that affect the customer experience docs Feature:Alerting/RulesFramework Issues related to the Alerting Rules Framework Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)
Projects
No open projects
AppEx: ResponseOps - Execution & Connectors
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[DOCS] Fixes data type for fields in find rules API lcawl/kibana
4 participants
@mikecote @ymao1 @elasticmachine @lcawl