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
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
- [x] Serverless docs — https://github.com/elastic/staging-serverless-security-docs/pull/324
- [x] Classic docs — https://github.com/elastic/security-docs/pull/5091
- [x] API docs (classic) — https://github.com/elastic/security-docs/pull/5095
Description
We need documentation for the setup guide field being added to the create/edit rule forms and the corresponding
setupfield 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 thesetupfields to the create/update/patch rules api schema - not just the response schema.Background & resources
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
setupfield 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