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

[Request] ESS docs for "Alert User Assignment" API #4475

Merged
merged 17 commits into from
Jan 4, 2024
Merged

[Request] ESS docs for "Alert User Assignment" API #4475

merged 17 commits into from
Jan 4, 2024

Conversation

nastasha-solomon
Copy link
Contributor

@nastasha-solomon nastasha-solomon commented Dec 14, 2023 •
edited
Loading

@nastasha-solomon nastasha-solomon added API Feature: Rules Team: Detection Engine Priority: High Issues that are time-sensitive and/or are of high customer importance Effort: Small Issues that can be resolved quickly v8.12.0 labels Dec 14, 2023
@nastasha-solomon nastasha-solomon self-assigned this Dec 14, 2023
@github-actions GitHub Actions
Copy link

A documentation preview will be available soon.

Help us out by validating the Buildkite preview and reporting issues here.
Please also be sure to double check all images to ensure they are correct in the preview.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@nastasha-solomon nastasha-solomon marked this pull request as ready for review January 3, 2024 05:36
@nastasha-solomon nastasha-solomon requested a review from a team as a code owner January 3, 2024 05:36
e40pud
e40pud previously approved these changes Jan 3, 2024
View reviewed changes
Copy link
Contributor

@e40pud e40pud left a comment

Choose a reason for hiding this comment

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

Thank you, LGTM!

natasha-moore-elastic
natasha-moore-elastic reviewed Jan 3, 2024
View reviewed changes
Copy link
Contributor

@natasha-moore-elastic natasha-moore-elastic left a comment

Choose a reason for hiding this comment

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

A couple of suggestions, otherwise looks good!

docs/detections/api/rules/signals-api-overview.asciidoc Outdated Show resolved Hide resolved
docs/detections/api/rules/signals-api-overview.asciidoc Outdated Show resolved Hide resolved
docs/detections/api/rules/signals-api-overview.asciidoc Show resolved Hide resolved
@nastasha-solomon @natasha-moore-elastic
Update docs/detections/api/rules/signals-api-overview.asciidoc
84bc75f 
Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
@nastasha-solomon nastasha-solomon requested a review from a team January 3, 2024 18:06
natasha-moore-elastic
natasha-moore-elastic reviewed Jan 4, 2024
View reviewed changes
Copy link
Contributor

@natasha-moore-elastic natasha-moore-elastic left a comment

Choose a reason for hiding this comment

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

A couple of tiny suggestions, thanks!

docs/detections/api/rules/signals-api-overview.asciidoc Outdated Show resolved Hide resolved
docs/detections/api/rules/signals-api-overview.asciidoc Outdated Show resolved Hide resolved
docs/detections/api/rules/signals-api-overview.asciidoc Outdated Show resolved Hide resolved
docs/detections/api/rules/signals-api-overview.asciidoc Outdated Show resolved Hide resolved
@natasha-moore-elastic
Copy link
Contributor

I know this is outside of the scope of this PR, but I’ve just noticed that on line 271, tags is defined as String[], but in the example on line 294, it’s actually an object.

nastasha-solomon and others added 2 commits January 4, 2024 09:35
@nastasha-solomon @natasha-moore-elastic
Update docs/detections/api/rules/signals-api-overview.asciidoc
92f8fb1 
Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
@nastasha-solomon @natasha-moore-elastic
Update docs/detections/api/rules/signals-api-overview.asciidoc
6837f93 
Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
@nastasha-solomon
Copy link
Contributor Author

I know this is outside of the scope of this PR, but I’ve just noticed that on line 271, tags is defined as String[], but in the example on line 294, it’s actually an object.

@natasha-moore-elastic good find! Can you file a doc bug for this so we can follow up on it with Davis outside of this PR? The change will need to be backported further back than 8.12, and it'd be better to do that in a separate PR.

@natasha-moore-elastic
Copy link
Contributor

natasha-moore-elastic commented Jan 4, 2024 •
edited
Loading

I know this is outside of the scope of this PR, but I’ve just noticed that on line 271, tags is defined as String[], but in the example on line 294, it’s actually an object.

@natasha-moore-elastic good find! Can you file a doc bug for this so we can follow up on it with Davis outside of this PR? The change will need to be backported further back than 8.12, and it'd be better to do that in a separate PR.

Sure, will do!

Edit: To close the loop, here's the doc issue and related PR that fixes this.

@nastasha-solomon nastasha-solomon merged commit 474ac29 into main Jan 4, 2024
4 checks passed
@nastasha-solomon nastasha-solomon deleted the issue-4461-alert-assign-api branch January 4, 2024 16:08
mergify bot pushed a commit that referenced this pull request Jan 4, 2024
@nastasha-solomon @mergify
[Request] ESS docs for "Alert User Assignment" API (#4475)
ee37c24 
* First draft

* Moved docs to correct location

* Removed space

* Update title

* Minor change

* request schema

* Update docs/detections/api/rules/signals-api-overview.asciidoc

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>

* Update docs/detections/api/rules/signals-api-overview.asciidoc

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>

* Update docs/detections/api/rules/signals-api-overview.asciidoc

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>

* Update docs/detections/api/rules/signals-api-overview.asciidoc

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>

* Styled text

---------

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
(cherry picked from commit 474ac29)
@mergify mergify bot mentioned this pull request Jan 4, 2024
Merged
nastasha-solomon added a commit that referenced this pull request Jan 9, 2024
@mergify @nastasha-solomon
[8.12] [Request] ESS docs for "Alert User Assignment" API (backport #…
bd84417 
…4475) (#4566)

* First draft

* Moved docs to correct location

* Removed space

* Update title

* Minor change

* request schema

* Update docs/detections/api/rules/signals-api-overview.asciidoc

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>

* Update docs/detections/api/rules/signals-api-overview.asciidoc

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>

* Update docs/detections/api/rules/signals-api-overview.asciidoc

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>

* Update docs/detections/api/rules/signals-api-overview.asciidoc

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>

* Styled text

---------

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
(cherry picked from commit 474ac29)

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@natasha-moore-elastic natasha-moore-elastic natasha-moore-elastic approved these changes

@e40pud e40pud e40pud left review comments

Assignees

@nastasha-solomon nastasha-solomon

Labels
API Effort: Small Issues that can be resolved quickly Feature: Rules Priority: High Issues that are time-sensitive and/or are of high customer importance Team: Detection Engine v8.12.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Request] ESS docs for "Alert User Assignment" API
3 participants
@nastasha-solomon @natasha-moore-elastic @e40pud