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

[Docs][Rules] Remove custom highlighted fields params from Rule Creation API Docs in 8.10 #4082

Closed
peluja1012 opened this issue Oct 20, 2023 · 2 comments
Closed

[Docs][Rules] Remove custom highlighted fields params from Rule Creation API Docs in 8.10 #4082

peluja1012 opened this issue Oct 20, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation Feature: Rules Team: Detection Engine Team: Security Solution v8.10.0

Comments

@peluja1012
Copy link
Contributor

peluja1012 commented Oct 20, 2023 •
edited
Loading

Description

In #3852, we added an API param (investigation_fields) to the docs to configure rule custom highlighted fields. We recently realized that we introduced a breaking change upon upgrade to 8.11 related to this new parameter. In order to avoid more users being exposed to this issue, we would like to remove API docs referencing this new param. I believe this documentation is only present here (screenshot below). The request is to remove it from the 8.10 public user docs. Other docs related to custom highlighted fields usage in the UI can remain.

image
@peluja1012 peluja1012 changed the title [Docs][Rules] Remove custom highlighted fields params from Rule Creation API Docs [Docs][Rules] Remove custom highlighted fields params from Rule Creation API Docs in 8.10 Oct 20, 2023
@nastasha-solomon nastasha-solomon mentioned this issue Oct 23, 2023
Merged
@nastasha-solomon
Copy link
Contributor

Thanks for filing this, @peluja1012! Docs are updated at #4085.

@yctercero @peluja1012 - if this issue with the investigation_fields needs to be doc'd as a breaking change in 8.11, can one of you drop the release notes summary as as comment in #4015? TY!

@nastasha-solomon
Copy link
Contributor

Closing this since merged #4085.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation Feature: Rules Team: Detection Engine Team: Security Solution v8.10.0
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@peluja1012 @nastasha-solomon