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

Document 'execution_summary' response part of detection APIs #1900

Merged
merged 4 commits into from
May 3, 2022

Conversation

xcrzx
Copy link
Contributor

@xcrzx xcrzx commented Apr 26, 2022

Resolves: #1759

Previews:

Summary

Document the execution_summary part of the rule schema and mark it as a feature under development

Screenshot 2022-04-28 at 18 03 42
.

@mergify
Copy link

mergify bot commented Apr 26, 2022

This pull request does not have a backport label. Could you fix it @xcrzx? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • v7.x is the label to automatically backport to the 7.x branch.
  • v7./d./d is the label to automatically backport to the 7./d branch. /d is the digit

NOTE: backport-skip has been added to this pull request.

@xcrzx xcrzx added Team: Docs Team: Detections/Response Detections and Response labels Apr 28, 2022
@xcrzx xcrzx marked this pull request as ready for review April 28, 2022 16:04
@xcrzx xcrzx self-assigned this May 2, 2022
@xcrzx xcrzx requested a review from a team May 2, 2022 14:00
Copy link
Contributor

@nastasha-solomon nastasha-solomon left a comment

Choose a reason for hiding this comment

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

Thanks for making this update @xcrzx ! I left one suggestion that can apply across all the entries if you decide to apply it. :)

docs/detections/api/rules/rules-api-bulk-actions.asciidoc Outdated Show resolved Hide resolved
Copy link
Contributor

@joepeeples joepeeples left a comment

Choose a reason for hiding this comment

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

Suggestion for revising the sample message, otherwise LGTM!

docs/detections/api/rules/rules-api-bulk-actions.asciidoc Outdated Show resolved Hide resolved
Copy link
Contributor

@benironside benironside left a comment

Choose a reason for hiding this comment

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

👍 Left one minor suggestion

docs/detections/api/rules/rules-api-bulk-actions.asciidoc Outdated Show resolved Hide resolved
@jmikell821 jmikell821 merged commit 70e0628 into main May 3, 2022
mergify bot pushed a commit that referenced this pull request May 3, 2022
* Document 'execution_summary' response part of detection APIs

* Apply suggestions

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
Co-authored-by: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com>
(cherry picked from commit 70e0628)
mergify bot pushed a commit that referenced this pull request May 3, 2022
* Document 'execution_summary' response part of detection APIs

* Apply suggestions

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
Co-authored-by: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com>
(cherry picked from commit 70e0628)
jmikell821 pushed a commit that referenced this pull request May 3, 2022
…1940)

* Document 'execution_summary' response part of detection APIs

* Apply suggestions

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
Co-authored-by: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com>
(cherry picked from commit 70e0628)

Co-authored-by: Dmitrii Shevchenko <dmshevch@gmail.com>
jmikell821 pushed a commit that referenced this pull request May 3, 2022
…1939)

* Document 'execution_summary' response part of detection APIs

* Apply suggestions

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
Co-authored-by: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com>
(cherry picked from commit 70e0628)

Co-authored-by: Dmitrii Shevchenko <dmshevch@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS] Execution summary is missing in the find rules API response
5 participants