[DOCS] Improves Detections API docs content #187224
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
natasha-moore-elastic
added
release_note:skip
natasha-moore-elastic
changed the title
30 tasks
natasha-moore-elastic
requested review from
szwarckonrad,
paul-tavares,
nkhristinin and
nikitaindik
banderror
added
Team:Detections and Resp
|
Pinging @elastic/security-detections-response (Team:Detections and Resp) |
|
Pinging @elastic/security-solution (Team: SecuritySolution) |
|
Pinging @elastic/security-detection-rule-management (Team:Detection Rule Management) |
|
Hi @tomsonpl - I replaced myself with you on this PR because I think you are the most knowledgable on these changes. Looks like there is only 4 files we are code owners for. There was a changes to the rule automated response actions schema (for OSQuery I think). Hope you don't mind 🙂 |
szwarckonrad
reviewed
Jul 4, 2024
...y_solution/common/api/detection_engine/alert_assignees/set_alert_assignees_route.schema.yaml
Outdated
Show resolved
Hide resolved
szwarckonrad
approved these changes
Jul 4, 2024
...y_solution/common/api/detection_engine/alert_assignees/set_alert_assignees_route.schema.yaml
Outdated
Show resolved
Hide resolved
...ty_solution/common/api/detection_engine/alert_tags/set_alert_tags/set_alert_tags.schema.yaml
Outdated
Show resolved
Hide resolved
⏳ Build in-progress, with failures
Failed CI StepsHistory |
maximpn
approved these changes
Jul 16, 2024
There was a problem hiding this comment.
@natasha-moore-elastic thank you for this PR 🙏
I like reworked summaries and descriptions. I didn't know that description block like below
> info
> You cannot add and remove the same assignee in the same request.
transforms into an info section in Bump.sh
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Resolves https://github.com/elastic/docs-projects/issues/219 by improving the Detections API docs content. Adds missing and improves existing operation summaries and operation descriptions.
Also addresses some of the work planned in #183702.