update README, adds integration test (skipped) for testing authz with search strategy

x-pack/plugins/rule_registry/README.md

@@ -27,9 +27,7 @@ On plugin setup, rule type producers can create the index template as follows:
 ```ts
 // get the FQN of the component template. All assets are prefixed with the configured `index` value, which is `.alerts` by default.
 
-const componentTemplateName = plugins.ruleRegistry.getFullAssetName(
-  'apm-mappings'
-);
+const componentTemplateName = plugins.ruleRegistry.getFullAssetName('apm-mappings');
 
 // if write is disabled, don't install these templates
 if (!plugins.ruleRegistry.isWriteEnabled()) {
@@ -73,14 +71,10 @@ await plugins.ruleRegistry.createOrUpdateComponentTemplate({
 await plugins.ruleRegistry.createOrUpdateIndexTemplate({
   name: plugins.ruleRegistry.getFullAssetName('apm-index-template'),
   body: {
-    index_patterns: [
-      plugins.ruleRegistry.getFullAssetName('observability-apm*'),
-    ],
+    index_patterns: [plugins.ruleRegistry.getFullAssetName('observability-apm*')],
     composed_of: [
       // Technical component template, required
-      plugins.ruleRegistry.getFullAssetName(
-        TECHNICAL_COMPONENT_TEMPLATE_NAME
-      ),
+      plugins.ruleRegistry.getFullAssetName(TECHNICAL_COMPONENT_TEMPLATE_NAME),
       componentTemplateName,
     ],
   },
@@ -107,8 +101,7 @@ await ruleDataClient.getWriter().bulk({
 // to read data, simply call ruleDataClient.getReader().search:
 const response = await ruleDataClient.getReader().search({
   body: {
-    query: {
-    },
+    query: {},
     size: 100,
     fields: ['*'],
     collapse: {
@@ -135,6 +128,7 @@ The following fields are defined in the technical field component template and s
 - `rule.name`: the name of the rule (as specified by the user).
 - `rule.category`: the name of the rule type (as defined by the rule type producer)
 - `kibana.rac.alert.producer`: the producer of the rule type. Usually a Kibana plugin. e.g., `APM`.
+- `kibana.rac.alert.owner`: the feature which produced the alert. Usually a Kibana feature id like `apm`, `siem`...
 - `kibana.rac.alert.id`: the id of the alert, that is unique within the context of the rule execution it was created in. E.g., for a rule that monitors latency for all services in all environments, this might be `opbeans-java:production`.
 - `kibana.rac.alert.uuid`: the unique identifier for the alert during its lifespan. If an alert recovers (or closes), this identifier is re-generated when it is opened again.
 - `kibana.rac.alert.status`: the status of the alert. Can be `open` or `closed`.
@@ -148,3 +142,16 @@ The following fields are defined in the technical field component template and s
 - `kibana.rac.alert.ancestors`: the array of ancestors (if any) for the alert.
 - `kibana.rac.alert.depth`: the depth of the alert in the ancestral tree (default 0).
 - `kibana.rac.alert.building_block_type`: the building block type of the alert (default undefined).
+
+# Alerts as data
+
+Alerts as data can be interacted with using the AlertsClient api found in `x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts`
+
+This api includes public methods such as
+
+[x] getFullAssetName
+[x] getAlertsIndex
+[x] get
+[x] update
+[ ] bulkUpdate (TODO)
+[ ] find (TODO)

x-pack/plugins/rule_registry/docs/README.md

@@ -0,0 +1,44 @@
+# Alerts as data Client API Docs
+
+This directory contains generated docs using `typedoc` for the alerts as data client (alerts client) API that can be called from other server
+plugins. This README will describe how to generate a new version of these markdown docs in the event that new methods
+or parameters are added.
+
+## TypeDoc Info
+
+See more info at: <https://typedoc.org/>
+and: <https://www.npmjs.com/package/typedoc-plugin-markdown> for the markdown plugin
+
+## Install dependencies
+
+```bash
+yarn global add typedoc typedoc-plugin-markdown
+```
+
+## Generate the docs
+
+```bash
+cd x-pack/plugins/rule_registry/docs
+npx typedoc --options alerts_client_typedoc.json
+```
+
+After running the above commands the files in the `server` directory will be updated to match the new tsdocs.
+If additional markdown directory should be created we can create a new typedoc configuration file and adjust the `out`
+directory accordingly.
+
+## Troubleshooting
+
+This will use the global `tsc` so ensure typescript is installed globally and one of typescript version `3.9, 4.0, 4.1, 4.2`.
+
+```
+$ tsc --version
+Version 4.2.4
+```
+
+If you run into tsc errors that seem unrelated to the cases plugin try executing these commands before running `typedoc`
+
+```bash
+cd <kibana root dir>
+npx yarn kbn bootstrap
+node scripts/build_ts_refs.js --clean --no-cache
+```

x-pack/plugins/rule_registry/docs/alerts_client/alerts_client_api.md

@@ -0,0 +1,14 @@
+Alerts as data client API Interface
+
+# Alerts as data client API Interface
+
+## Table of contents
+
+### Classes
+
+- [AlertsClient](classes/alertsclient.md)
+
+### Interfaces
+
+- [ConstructorOptions](interfaces/constructoroptions.md)
+- [UpdateOptions](interfaces/updateoptions.md)

x-pack/plugins/rule_registry/docs/alerts_client/classes/alertsclient.md

@@ -0,0 +1,195 @@
+[Alerts as data client API Interface](../alerts_client_api.md) / AlertsClient
+
+# Class: AlertsClient
+
+Provides apis to interact with alerts as data
+ensures the request is authorized to perform read / write actions
+on alerts as data.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](alertsclient.md#constructor)
+
+### Properties
+
+- [auditLogger](alertsclient.md#auditlogger)
+- [authorization](alertsclient.md#authorization)
+- [esClient](alertsclient.md#esclient)
+- [logger](alertsclient.md#logger)
+- [ruleDataService](alertsclient.md#ruledataservice)
+
+### Methods
+
+- [fetchAlert](alertsclient.md#fetchalert)
+- [get](alertsclient.md#get)
+- [getAlertsIndex](alertsclient.md#getalertsindex)
+- [getFullAssetName](alertsclient.md#getfullassetname)
+- [update](alertsclient.md#update)
+
+## Constructors
+
+### constructor
+
+• **new AlertsClient**(`__namedParameters`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `__namedParameters` | [ConstructorOptions](../interfaces/constructoroptions.md) |
+
+#### Defined in
+
+[alerts_client.ts:56](https://github.com/dhurley14/kibana/blob/25bf227f8c6/x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts#L56)
+
+## Properties
+
+### auditLogger
+
+• `Private` `Optional` `Readonly` **auditLogger**: `AuditLogger`
+
+#### Defined in
+
+[alerts_client.ts:53](https://github.com/dhurley14/kibana/blob/25bf227f8c6/x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts#L53)
+
+___
+
+### authorization
+
+• `Private` `Readonly` **authorization**: `PublicMethodsOf`<AlertingAuthorization\>
+
+#### Defined in
+
+[alerts_client.ts:54](https://github.com/dhurley14/kibana/blob/25bf227f8c6/x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts#L54)
+
+___
+
+### esClient
+
+• `Private` `Readonly` **esClient**: `ElasticsearchClient`
+
+#### Defined in
+
+[alerts_client.ts:55](https://github.com/dhurley14/kibana/blob/25bf227f8c6/x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts#L55)
+
+___
+
+### logger
+
+• `Private` `Readonly` **logger**: `Logger`
+
+#### Defined in
+
+[alerts_client.ts:52](https://github.com/dhurley14/kibana/blob/25bf227f8c6/x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts#L52)
+
+___
+
+### ruleDataService
+
+• `Private` `Readonly` **ruleDataService**: `PublicMethodsOf`<RuleDataPluginService\>
+
+#### Defined in
+
+[alerts_client.ts:56](https://github.com/dhurley14/kibana/blob/25bf227f8c6/x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts#L56)
+
+## Methods
+
+### fetchAlert
+
+▸ `Private` **fetchAlert**(`__namedParameters`): `Promise`<OutputOf<SetOptional<`Object`\>\>\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `__namedParameters` | `GetAlertParams` |
+
+#### Returns
+
+`Promise`<OutputOf<SetOptional<`Object`\>\>\>
+
+#### Defined in
+
+[alerts_client.ts:83](https://github.com/dhurley14/kibana/blob/25bf227f8c6/x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts#L83)
+
+___
+
+### get
+
+▸ **get**(`__namedParameters`): `Promise`<OutputOf<SetOptional<`Object`\>\>\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `__namedParameters` | `GetAlertParams` |
+
+#### Returns
+
+`Promise`<OutputOf<SetOptional<`Object`\>\>\>
+
+#### Defined in
+
+[alerts_client.ts:108](https://github.com/dhurley14/kibana/blob/25bf227f8c6/x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts#L108)
+
+___
+
+### getAlertsIndex
+
+▸ **getAlertsIndex**(`featureIds`): `Promise`<undefined \| string[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `featureIds` | `string`[] |
+
+#### Returns
+
+`Promise`<undefined \| string[]\>
+
+#### Defined in
+
+[alerts_client.ts:76](https://github.com/dhurley14/kibana/blob/25bf227f8c6/x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts#L76)
+
+___
+
+### getFullAssetName
+
+▸ **getFullAssetName**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[alerts_client.ts:72](https://github.com/dhurley14/kibana/blob/25bf227f8c6/x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts#L72)
+
+___
+
+### update
+
+▸ **update**<Params\>(`__namedParameters`): `Promise`<undefined \| ``null`` \| OutputOf<SetOptional<`Object`\>\>\>
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `Params` | `Params`: `AlertTypeParams` = `never` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `__namedParameters` | [UpdateOptions](../interfaces/updateoptions.md)<Params\> |
+
+#### Returns
+
+`Promise`<undefined \| ``null`` \| OutputOf<SetOptional<`Object`\>\>\>
+
+#### Defined in
+
+[alerts_client.ts:146](https://github.com/dhurley14/kibana/blob/25bf227f8c6/x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts#L146)

x-pack/plugins/rule_registry/docs/alerts_client/interfaces/constructoroptions.md

@@ -0,0 +1,63 @@
+[Alerts as data client API Interface](../alerts_client_api.md) / ConstructorOptions
+
+# Interface: ConstructorOptions
+
+## Table of contents
+
+### Properties
+
+- [auditLogger](constructoroptions.md#auditlogger)
+- [authorization](constructoroptions.md#authorization)
+- [esClient](constructoroptions.md#esclient)
+- [logger](constructoroptions.md#logger)
+- [ruleDataService](constructoroptions.md#ruledataservice)
+
+## Properties
+
+### auditLogger
+
+• `Optional` **auditLogger**: `AuditLogger`
+
+#### Defined in
+
+[alerts_client.ts:26](https://github.com/dhurley14/kibana/blob/25bf227f8c6/x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts#L26)
+
+___
+
+### authorization
+
+• **authorization**: `PublicMethodsOf`<AlertingAuthorization\>
+
+#### Defined in
+
+[alerts_client.ts:25](https://github.com/dhurley14/kibana/blob/25bf227f8c6/x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts#L25)
+
+___
+
+### esClient
+
+• **esClient**: `ElasticsearchClient`
+
+#### Defined in
+
+[alerts_client.ts:27](https://github.com/dhurley14/kibana/blob/25bf227f8c6/x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts#L27)
+
+___
+
+### logger
+
+• **logger**: `Logger`
+
+#### Defined in
+
+[alerts_client.ts:24](https://github.com/dhurley14/kibana/blob/25bf227f8c6/x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts#L24)
+
+___
+
+### ruleDataService
+
+• **ruleDataService**: `PublicMethodsOf`<RuleDataPluginService\>
+
+#### Defined in
+
+[alerts_client.ts:28](https://github.com/dhurley14/kibana/blob/25bf227f8c6/x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts#L28)