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

[Known issue][Detection Engine][8.16.0 & 8.16.1] Exception item comment validation on newline chars #6280

Open
wants to merge 20 commits into
base: 8.x
Choose a base branch
from

Conversation

nastasha-solomon
Copy link
Contributor

@nastasha-solomon nastasha-solomon commented Dec 5, 2024

Partially addresses #6275 by updating the 8.16.0 and 8.16.1 release notes. This will be doc'd as a known issue for 8.17 in #6224.

Preview: 8.16.x release notes

@nastasha-solomon nastasha-solomon added release-notes known-issue Priority: High Issues that are time-sensitive and/or are of high customer importance Effort: Small Issues that can be resolved quickly v8.16.0 v8.16.1 labels Dec 5, 2024
@nastasha-solomon nastasha-solomon self-assigned this Dec 5, 2024
Copy link

github-actions bot commented Dec 5, 2024

A documentation preview will be available soon.

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 December 6, 2024 19:05
@nastasha-solomon nastasha-solomon requested a review from a team as a code owner December 6, 2024 19:05
@nastasha-solomon nastasha-solomon changed the title [Known issue][Detection Engine] Exception item comment validation on newline chars [Known issue][Detection Engine][8.16.0 & 8.16.1] Exception item comment validation on newline chars Dec 6, 2024
Copy link
Contributor

@rylnd rylnd left a comment

Choose a reason for hiding this comment

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

@nastasha-solomon I had a few suggestions; they apply to both sections but I didn't duplicate the suggested changes. Let me know if you have any questions.

docs/release-notes/8.16.asciidoc Outdated Show resolved Hide resolved
docs/release-notes/8.16.asciidoc Outdated Show resolved Hide resolved
docs/release-notes/8.16.asciidoc Outdated Show resolved Hide resolved
nastasha-solomon and others added 3 commits December 6, 2024 15:40
Co-authored-by: Ryland Herrick <ryalnd@gmail.com>
Co-authored-by: Ryland Herrick <ryalnd@gmail.com>
Co-authored-by: Ryland Herrick <ryalnd@gmail.com>
Copy link
Contributor

@rylnd rylnd 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 for adding markup, links, and much-needed grammar here! LGTM.

docs/release-notes/8.16.asciidoc Outdated Show resolved Hide resolved
+
[source,console]
----
curl -XPOST -H 'Authorization: ApiKey API_KEY_HERE' -H 'kbn-xsrf: true' -H 'elastic-api-version: 2023-10-31' 'KIBANA_URL/api/exception_lists/_export?list_id=f75aae6f-0229-413f-881d-81cb3abfbe2d&id=490525a2-eb66-4320-95b5-88bdd1302dc4&namespace_type=single' -o list.ndjson
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure how we usually document curl requests, do we need to specify that they need to also include the space? If not, ignore.

Suggested change
curl -XPOST -H 'Authorization: ApiKey API_KEY_HERE' -H 'kbn-xsrf: true' -H 'elastic-api-version: 2023-10-31' 'KIBANA_URL/api/exception_lists/_export?list_id=f75aae6f-0229-413f-881d-81cb3abfbe2d&id=490525a2-eb66-4320-95b5-88bdd1302dc4&namespace_type=single' -o list.ndjson
curl -XPOST -H 'Authorization: ApiKey API_KEY_HERE' -H 'kbn-xsrf: true' -H 'elastic-api-version: 2023-10-31' '${KIBANA_URL}${SPACE_URL}/api/exception_lists/_export?list_id=f75aae6f-0229-413f-881d-81cb3abfbe2d&id=490525a2-eb66-4320-95b5-88bdd1302dc4&namespace_type=single' -o list.ndjson

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good question, I'm not sure. Do users still need to specify the space if they're using the default one?

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't believe so, think just if they need to hit a different space. Might be worth just noting somewhere though to make sure to include space if other than default?

Copy link
Contributor

@yctercero yctercero 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, thank you! Left one minor comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Effort: Small Issues that can be resolved quickly known-issue Priority: High Issues that are time-sensitive and/or are of high customer importance release-notes v8.16.0 v8.16.1 v8.17.0 v8.18.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants