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

[Detection Engine] update API docs for new ES|QL rule #4052

Merged

vitaliidm merged 28 commits into elastic:main from vitaliidm:esql-api

Oct 26, 2023

Contributor

vitaliidm commented Oct 17, 2023 •

edited by nastasha-solomon

Loading

Contributes to #3817.

Previews:


          initial commit

3dc8d32

github-actions bot commented Oct 17, 2023

Documentation previews:

✨ HTML diff
📙 Elastic Security Guide

Contributor

mergify bot commented Oct 17, 2023

This pull request does not have a backport label. Could you fix it @vitaliidm? 🙏
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.

mergify bot added the backport-skip label


          updates doc

1ef78b7

nastasha-solomon mentioned this pull request

[Detection Engine][ESQL] - Document new rule type #3817

Closed

4 tasks


          update API

b05ceb6

vitaliidm added the v8.11.0 label

mergify bot removed the backport-skip label

vitaliidm self-assigned this

vitaliidm added Feature: Rules Team: Detection Engine labels

natasha-moore-elastic reviewed

View reviewed changes

Contributor

natasha-moore-elastic left a comment

Thanks for raising the PR, @vitaliidm ! Can we add request and response examples for creating an ESQL rule to the rules-api-create page? Just to keep the consistency, as the page contains examples for all other rule types.

docs/detections/api/rules/rules-api-create.asciidoc Outdated Show resolved Hide resolved

docs/detections/api/rules/rules-api-create.asciidoc Outdated Show resolved Hide resolved

docs/detections/api/rules/rules-api-update.asciidoc Outdated Show resolved Hide resolved

vitaliidm changed the title ~~[Detection Engine] update API docs for new ES|QL rule~~ [Draft][Detection Engine] update API docs for new ES|QL rule

vitaliidm and others added 5 commits

October 18, 2023 10:41


          Update docs/detections/api/rules/rules-api-create.asciidoc

92577dc

Co-authored-by: natasha-moore-elastic <[email protected]>


          Update docs/detections/api/rules/rules-api-create.asciidoc

d05aa8b

Co-authored-by: natasha-moore-elastic <[email protected]>


          Update docs/detections/api/rules/rules-api-update.asciidoc

71de0eb

Co-authored-by: natasha-moore-elastic <[email protected]>


          CR feedback

79423b9


          Merge branch 'esql-api' of ssh://github.com/vitaliidm/security-docs i…

122e781

…nto esql-api

vitaliidm changed the title ~~[Draft][Detection Engine] update API docs for new ES|QL rule~~ [Detection Engine] update API docs for new ES|QL rule

vitaliidm requested review from natasha-moore-elastic and nastasha-solomon

October 18, 2023 11:28

natasha-moore-elastic reviewed

View reviewed changes

docs/detections/api/rules/rules-api-create.asciidoc Outdated Show resolved Hide resolved

natasha-moore-elastic reviewed

View reviewed changes

docs/detections/api/rules/rules-api-create.asciidoc Outdated Show resolved Hide resolved

vitaliidm and others added 2 commits

October 18, 2023 13:02


          Update docs/detections/api/rules/rules-api-create.asciidoc

11c615d

Co-authored-by: natasha-moore-elastic <[email protected]>


          Update docs/detections/api/rules/rules-api-create.asciidoc

ef14010

Co-authored-by: natasha-moore-elastic <[email protected]>

nastasha-solomon reviewed

View reviewed changes

Contributor

nastasha-solomon left a comment •

edited

Loading

Thank you for adding this content, @vitaliidm! I left some feedback and questions for your review. Let me know if I can elaborate on anything.

docs/detections/api/rules/rules-api-create.asciidoc Outdated Show resolved Hide resolved

docs/detections/api/rules/rules-api-create.asciidoc Outdated Show resolved Hide resolved

docs/detections/api/rules/rules-api-create.asciidoc Outdated Show resolved Hide resolved

docs/detections/api/rules/rules-api-create.asciidoc Outdated Show resolved Hide resolved

docs/detections/api/rules/rules-api-update.asciidoc Outdated Show resolved Hide resolved

docs/detections/api/rules/rules-api-create.asciidoc Outdated Show resolved Hide resolved

docs/detections/api/rules/rules-api-update.asciidoc Outdated Show resolved Hide resolved

docs/detections/api/rules/rules-api-create.asciidoc Outdated Show resolved Hide resolved

nastasha-solomon linked an issue

that may be closed by this pull request

[Detection Engine][ESQL] - Document new rule type #3817

Closed

4 tasks

vitaliidm and others added 2 commits

October 18, 2023 15:48


          Update docs/detections/api/rules/rules-api-create.asciidoc

5f67351

Co-authored-by: Nastasha Solomon <[email protected]>


          Update docs/detections/api/rules/rules-api-create.asciidoc

b2dad40

Co-authored-by: Nastasha Solomon <[email protected]>

vitaliidm and others added 10 commits

October 18, 2023 16:10

CR

3bad833


          Update docs/detections/api/rules/rules-api-create.asciidoc

faaf521

Co-authored-by: Nastasha Solomon <[email protected]>


          Update docs/detections/api/rules/rules-api-update.asciidoc

a8023c6

Co-authored-by: Nastasha Solomon <[email protected]>


          Combining tables and adding note to update rule

73dff75


          Update docs/detections/api/rules/rules-api-create.asciidoc

8aaaec9


          Merge branch 'main' into esql-api

a13764c


          Removing extra term

3184ad9


          Combining tables in create rule

5d69fe4


          Fixing tag rendering

2eda287


          Adding ref to UI docs

576067e

nastasha-solomon self-assigned this


          littile cleanup and fixes

0ef8d4e

vitaliidm requested review from natasha-moore-elastic and nastasha-solomon

October 19, 2023 10:14

natasha-moore-elastic reviewed

View reviewed changes

Contributor

natasha-moore-elastic left a comment

Looks good, just a couple of suggestions to make spacing in the code examples consistent with other examples.

docs/detections/api/rules/rules-api-create.asciidoc Outdated Show resolved Hide resolved

docs/detections/api/rules/rules-api-create.asciidoc Outdated Show resolved Hide resolved

vitaliidm and others added 2 commits

October 23, 2023 14:27


          Update docs/detections/api/rules/rules-api-create.asciidoc

01d1c7f

Co-authored-by: natasha-moore-elastic <[email protected]>


          Update docs/detections/api/rules/rules-api-create.asciidoc

4b04630

Co-authored-by: natasha-moore-elastic <[email protected]>

natasha-moore-elastic approved these changes

View reviewed changes

nastasha-solomon approved these changes

View reviewed changes

Contributor

nastasha-solomon left a comment

Just left one suggestion. Otherwise, LGTM! Thanks for putting this together, @vitaliidm!

docs/detections/api/rules/rules-api-create.asciidoc Outdated Show resolved Hide resolved

vitaliidm and others added 3 commits

October 24, 2023 15:31


          Update docs/detections/api/rules/rules-api-create.asciidoc

4b8a2a2

Co-authored-by: Nastasha Solomon <[email protected]>


          Merge branch 'main' into esql-api

476d532


          Merge branch 'main' into esql-api

afc4ab5

vitaliidm merged commit 5f33c46 into elastic:main

1 check passed

mergify bot pushed a commit that referenced this pull request


          [Detection Engine] update API docs for new ES|QL rule (#4052)

180eab8

* initial commit

* updates doc

* update API

* Update docs/detections/api/rules/rules-api-create.asciidoc

Co-authored-by: natasha-moore-elastic <[email protected]>

* Update docs/detections/api/rules/rules-api-create.asciidoc

Co-authored-by: natasha-moore-elastic <[email protected]>

* Update docs/detections/api/rules/rules-api-update.asciidoc

Co-authored-by: natasha-moore-elastic <[email protected]>

* CR feedback

* Update docs/detections/api/rules/rules-api-create.asciidoc

Co-authored-by: natasha-moore-elastic <[email protected]>

* Update docs/detections/api/rules/rules-api-create.asciidoc

Co-authored-by: natasha-moore-elastic <[email protected]>

* Update docs/detections/api/rules/rules-api-create.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

* Update docs/detections/api/rules/rules-api-create.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

* CR

* Update docs/detections/api/rules/rules-api-create.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

* Update docs/detections/api/rules/rules-api-update.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

* Combining tables and adding note to update rule

* Update docs/detections/api/rules/rules-api-create.asciidoc

* Removing extra term

* Combining tables in create rule

* Fixing tag rendering

* Adding ref to UI docs

* littile cleanup and fixes

* Update docs/detections/api/rules/rules-api-create.asciidoc

Co-authored-by: natasha-moore-elastic <[email protected]>

* Update docs/detections/api/rules/rules-api-create.asciidoc

Co-authored-by: natasha-moore-elastic <[email protected]>

* Update docs/detections/api/rules/rules-api-create.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

---------

Co-authored-by: natasha-moore-elastic <[email protected]>
Co-authored-by: Nastasha Solomon <[email protected]>
Co-authored-by: nastasha.solomon <[email protected]>
(cherry picked from commit 5f33c46)

mergify bot mentioned this pull request

[8.11] [Detection Engine] update API docs for new ES|QL rule (backport #4052) #4106

Merged

nastasha-solomon added a commit that referenced this pull request


          [8.11] [Detection Engine] update API docs for new ES|QL rule (backport …

0037bf3

…#4052) (#4106)

Co-authored-by: natasha-moore-elastic <[email protected]>
Co-authored-by: Nastasha Solomon <[email protected]>
Co-authored-by: nastasha.solomon <[email protected]>
Co-authored-by: Vitalii Dmyterko <[email protected]>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Feature: Rules Team: Detection Engine v8.11.0