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

[DOCS] Improve documentation for the bulk actions API #3019

Open
4 tasks
Tracked by #200310
banderror opened this issue Feb 23, 2023 · 0 comments
Open
4 tasks
Tracked by #200310

[DOCS] Improve documentation for the bulk actions API #3019

banderror opened this issue Feb 23, 2023 · 0 comments
Assignees

Comments

@banderror
Copy link
Contributor

banderror commented Feb 23, 2023

Epic: elastic/kibana#200310
Based on the feedback from @Tibo669 in #2985

Summary

Let's improve the docs for the Bulk rule actions API endpoints.

Current issues with this page:

  • It documents several different endpoints and contains a lot of text that is hard to navigate.
  • Despite the size, it's not super strict and clear in terms of request and response schemas, for example, rule action parameters.
  • Despite the size, it lacks a lot of examples for every bulk action we support, especially bulk editing.

Criteria:

  • Each bulk endpoint should be documented on its own separate page: _bulk_create, _bulk_delete, PUT _bulk_update, PATCH _bulk_update, _bulk_action.
  • The page for the _bulk_action endpoint should contain a common description, request/response schema, and examples of usage of this endpoint. E.g. docs on the dry-run mode.
  • Each concrete bulk action should be documented on its own sub-page under _bulk_action: delete, disable, enable, export, duplicate, and edit.
  • All schemas should be documented in detail and with examples. For example, for each connector type we support in bulk editing rule actions, we should have a separate section documenting the request schema and examples of usage.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants