Edit setup guide field for custom rules in UI and API

[dplumlee]

Description

We need documentation for the setup guide field being added to the create/edit rule forms and the corresponding setup field being added to the related API schemas. Right now, the setup field is a prebuilt rules only field - this change will allow the field to be used in custom rules as well by adding a markdown container to the create/edit rule ui forms and adding the setup fields to the create/update/patch rules api schema - not just the response schema.

Background & resources

• PRs: [Security Solution] Allow users to edit setup field for custom rules kibana#178131
• Issues/metas: [Security Solution] Allow users to edit setup field for custom rules kibana#173626
• Point of contact: @dplumlee

Which documentation set does this change impact?

ESS and serverless

ESS release

8.14.0

Serverless release

The week of April 15, 2024

Feature differences

The feature is identical in ESS/serverless

API docs impact

Right now the setup field is documented in our response schema (as a default empty string). This update will add the field to the create and update (POST/PUT/PATCH) schemas as a defaultable (optional) field. It will default to an empty string if not included.

Prerequisites, privileges, feature flags

No response

---

Pull requests

Beta Give feedback

1. Serverless docs — https://github.com/elastic/staging-serverless-security-docs/pull/324
2. Classic docs — Editable setup guide field for custom rules [classic] #5091
3. API docs (classic) — Updates setup guide field API docs #5095

[joepeeples]

@dplumlee I don't think we can have docs ready in time for the serverless release of week of March 18th, since that's just a few days after this issue was opened, and that week the docs team is already committed to be working heavily on 8.13 features. I'll try to prioritize this soon after we get the 8.13 features covered.