Issue

The consumer field in our Rules API is a common source of confusion and SDHs. Our current documentation only lists possible values but does not explain their meaning or their purpose. (Some of the values might even be deprecated.)

The name of the application or feature that owns the rule. For example: alerts, apm, discover, infrastructure, logs, metrics, ml, monitoring, securitySolution, siem, stackAlerts, or uptime.

Objective

We should improve the consumer field documentation for the Rule API. This includes the create rule API and the rule API response.

Links

• Code
  • https://github.com/elastic/kibana/blob/main/x-pack/plugins/alerting/common/routes/rule/apis/create/schemas/v1.ts#L151
  • https://github.com/elastic/kibana/blob/main/x-pack/plugins/alerting/common/routes/rule/response/schemas/v1.ts#L495
• Documentation links
  • https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-createruleid#operation-createruleid-body-application-json-elastic-api-version-2023-10-31-consumer
  • https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-getrule#operation-getrule-200-body-application-json-elastic-api-version-2023-10-31-consumer