Update from CPTNB/OpenSearch-Dashboards@dfbcfae

source/index.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+|  Package | Description |
+|  --- | --- |
+|  [opensearch-dashboards](./opensearch-dashboards.md) | The OpenSearch Dashboards Core APIs for server-side plugins.<!-- -->A plugin requires a <code>opensearch_dashboards.json</code> file at it's root directory that follows  to define static plugin information required to load the plugin.<!-- -->A plugin's <code>server/index</code> file must contain a named import, <code>plugin</code>, that implements  which returns an object that implements .<!-- -->The plugin integrates with the core system via lifecycle events: <code>setup</code>, <code>start</code>, and <code>stop</code>. In each lifecycle method, the plugin will receive the corresponding core services available (either  or ) and any interfaces returned by dependency plugins' lifecycle method. Anything returned by the plugin's lifecycle method will be exposed to downstream dependencies when their corresponding lifecycle methods are invoked. |
+

source/opensearch-dashboards.appcategory.arialabel.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [opensearch-dashboards](./opensearch-dashboards.md) &gt; [AppCategory](./opensearch-dashboards.appcategory.md) &gt; [ariaLabel](./opensearch-dashboards.appcategory.arialabel.md)
+
+## AppCategory.ariaLabel property
+
+If the visual label isn't appropriate for screen readers, can override it here
+
+<b>Signature:</b>
+
+```typescript
+ariaLabel?: string;
+```

source/opensearch-dashboards.appcategory.euiicontype.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [opensearch-dashboards](./opensearch-dashboards.md) &gt; [AppCategory](./opensearch-dashboards.appcategory.md) &gt; [euiIconType](./opensearch-dashboards.appcategory.euiicontype.md)
+
+## AppCategory.euiIconType property
+
+Define an icon to be used for the category If the category is only 1 item, and no icon is defined, will default to the product icon Defaults to initials if no icon is defined
+
+<b>Signature:</b>
+
+```typescript
+euiIconType?: any;
+```

source/opensearch-dashboards.appcategory.id.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [opensearch-dashboards](./opensearch-dashboards.md) &gt; [AppCategory](./opensearch-dashboards.appcategory.md) &gt; [id](./opensearch-dashboards.appcategory.id.md)
+
+## AppCategory.id property
+
+Unique identifier for the categories
+
+<b>Signature:</b>
+
+```typescript
+id: string;
+```

source/opensearch-dashboards.appcategory.label.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [opensearch-dashboards](./opensearch-dashboards.md) &gt; [AppCategory](./opensearch-dashboards.appcategory.md) &gt; [label](./opensearch-dashboards.appcategory.label.md)
+
+## AppCategory.label property
+
+Label used for category name. Also used as aria-label if one isn't set.
+
+<b>Signature:</b>
+
+```typescript
+label: string;
+```

source/opensearch-dashboards.appcategory.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [opensearch-dashboards](./opensearch-dashboards.md) &gt; [AppCategory](./opensearch-dashboards.appcategory.md)
+
+## AppCategory interface
+
+A category definition for nav links to know where to sort them in the left hand nav
+
+<b>Signature:</b>
+
+```typescript
+export interface AppCategory 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [ariaLabel?](./opensearch-dashboards.appcategory.arialabel.md) | string | <i>(Optional)</i> If the visual label isn't appropriate for screen readers, can override it here |
+|  [euiIconType?](./opensearch-dashboards.appcategory.euiicontype.md) | any | <i>(Optional)</i> Define an icon to be used for the category If the category is only 1 item, and no icon is defined, will default to the product icon Defaults to initials if no icon is defined |
+|  [id](./opensearch-dashboards.appcategory.id.md) | string | Unique identifier for the categories |
+|  [label](./opensearch-dashboards.appcategory.label.md) | string | Label used for category name. Also used as aria-label if one isn't set. |
+|  [order?](./opensearch-dashboards.appcategory.order.md) | number | <i>(Optional)</i> The order that categories will be sorted in Prefer large steps between categories to allow for further editing (Default categories are in steps of 1000) |
+

source/opensearch-dashboards.appcategory.order.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [opensearch-dashboards](./opensearch-dashboards.md) &gt; [AppCategory](./opensearch-dashboards.appcategory.md) &gt; [order](./opensearch-dashboards.appcategory.order.md)
+
+## AppCategory.order property
+
+The order that categories will be sorted in Prefer large steps between categories to allow for further editing (Default categories are in steps of 1000)
+
+<b>Signature:</b>
+
+```typescript
+order?: number;
+```

source/opensearch-dashboards.appenderconfigtype.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [opensearch-dashboards](./opensearch-dashboards.md) &gt; [AppenderConfigType](./opensearch-dashboards.appenderconfigtype.md)
+
+## AppenderConfigType type
+
+
+<b>Signature:</b>
+
+```typescript
+export declare type AppenderConfigType = ConsoleAppenderConfig | FileAppenderConfig | LegacyAppenderConfig;
+```

source/opensearch-dashboards.assistanceapiresponse.indices.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [opensearch-dashboards](./opensearch-dashboards.md) &gt; [AssistanceAPIResponse](./opensearch-dashboards.assistanceapiresponse.md) &gt; [indices](./opensearch-dashboards.assistanceapiresponse.indices.md)
+
+## AssistanceAPIResponse.indices property
+
+<b>Signature:</b>
+
+```typescript
+indices: {
+        [indexName: string]: {
+            action_required: MIGRATION_ASSISTANCE_INDEX_ACTION;
+        };
+    };
+```

source/opensearch-dashboards.assistanceapiresponse.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [opensearch-dashboards](./opensearch-dashboards.md) &gt; [AssistanceAPIResponse](./opensearch-dashboards.assistanceapiresponse.md)
+
+## AssistanceAPIResponse interface
+
+> Warning: This API is now obsolete.
+> 
+> 
+
+<b>Signature:</b>
+
+```typescript
+export interface AssistanceAPIResponse 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [indices](./opensearch-dashboards.assistanceapiresponse.indices.md) | { \[indexName: string\]: { action\_required: [MIGRATION\_ASSISTANCE\_INDEX\_ACTION](./opensearch-dashboards.migration_assistance_index_action.md)<!-- -->; }; } |  |
+

source/opensearch-dashboards.assistantapiclientparams.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [opensearch-dashboards](./opensearch-dashboards.md) &gt; [AssistantAPIClientParams](./opensearch-dashboards.assistantapiclientparams.md)
+
+## AssistantAPIClientParams interface
+
+> Warning: This API is now obsolete.
+> 
+> 
+
+<b>Signature:</b>
+
+```typescript
+export interface AssistantAPIClientParams extends GenericParams 
+```
+<b>Extends:</b> GenericParams
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [method](./opensearch-dashboards.assistantapiclientparams.method.md) | 'GET' |  |
+|  [path](./opensearch-dashboards.assistantapiclientparams.path.md) | '/\_migration/assistance' |  |
+

source/opensearch-dashboards.assistantapiclientparams.method.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [opensearch-dashboards](./opensearch-dashboards.md) &gt; [AssistantAPIClientParams](./opensearch-dashboards.assistantapiclientparams.md) &gt; [method](./opensearch-dashboards.assistantapiclientparams.method.md)
+
+## AssistantAPIClientParams.method property
+
+<b>Signature:</b>
+
+```typescript
+method: 'GET';
+```

source/opensearch-dashboards.assistantapiclientparams.path.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [opensearch-dashboards](./opensearch-dashboards.md) &gt; [AssistantAPIClientParams](./opensearch-dashboards.assistantapiclientparams.md) &gt; [path](./opensearch-dashboards.assistantapiclientparams.path.md)
+
+## AssistantAPIClientParams.path property
+
+<b>Signature:</b>
+
+```typescript
+path: '/_migration/assistance';
+```

source/opensearch-dashboards.auditableevent.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [opensearch-dashboards](./opensearch-dashboards.md) &gt; [AuditableEvent](./opensearch-dashboards.auditableevent.md)
+
+## AuditableEvent interface
+
+Event to audit.
+
+<b>Signature:</b>
+
+```typescript
+export interface AuditableEvent 
+```
+
+## Remarks
+
+Not a complete interface.
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [message](./opensearch-dashboards.auditableevent.message.md) | string |  |
+|  [type](./opensearch-dashboards.auditableevent.type.md) | string |  |
+

source/opensearch-dashboards.auditableevent.message.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [opensearch-dashboards](./opensearch-dashboards.md) &gt; [AuditableEvent](./opensearch-dashboards.auditableevent.md) &gt; [message](./opensearch-dashboards.auditableevent.message.md)
+
+## AuditableEvent.message property
+
+<b>Signature:</b>
+
+```typescript
+message: string;
+```

source/opensearch-dashboards.auditableevent.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [opensearch-dashboards](./opensearch-dashboards.md) &gt; [AuditableEvent](./opensearch-dashboards.auditableevent.md) &gt; [type](./opensearch-dashboards.auditableevent.type.md)
+
+## AuditableEvent.type property
+
+<b>Signature:</b>
+
+```typescript
+type: string;
+```

source/opensearch-dashboards.auditor.add.md

@@ -0,0 +1,35 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [opensearch-dashboards](./opensearch-dashboards.md) &gt; [Auditor](./opensearch-dashboards.auditor.md) &gt; [add](./opensearch-dashboards.auditor.add.md)
+
+## Auditor.add() method
+
+Add a record to audit log. Service attaches to a log record: - metadata about an end-user initiating an operation - scope name, if presents
+
+<b>Signature:</b>
+
+```typescript
+add(event: AuditableEvent): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  event | [AuditableEvent](./opensearch-dashboards.auditableevent.md) |  |
+
+<b>Returns:</b>
+
+void
+
+## Example
+
+How to add a record in audit log:
+
+```typescript
+router.get({ path: '/my_endpoint', validate: false }, async (context, request, response) => {
+  context.core.auditor.withAuditScope('my_plugin_operation');
+  const value = await context.core.opensearch.legacy.client.callAsCurrentUser('...');
+  context.core.add({ type: 'operation.type', message: 'perform an operation in ... endpoint' });
+```
+

source/opensearch-dashboards.auditor.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [opensearch-dashboards](./opensearch-dashboards.md) &gt; [Auditor](./opensearch-dashboards.auditor.md)
+
+## Auditor interface
+
+Provides methods to log user actions and access events.
+
+<b>Signature:</b>
+
+```typescript
+export interface Auditor 
+```
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [add(event)](./opensearch-dashboards.auditor.add.md) | Add a record to audit log. Service attaches to a log record: - metadata about an end-user initiating an operation - scope name, if presents |
+|  [withAuditScope(name)](./opensearch-dashboards.auditor.withauditscope.md) | Add a high-level scope name for logged events. It helps to identify the root cause of low-level events. |
+

source/opensearch-dashboards.auditor.withauditscope.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [opensearch-dashboards](./opensearch-dashboards.md) &gt; [Auditor](./opensearch-dashboards.auditor.md) &gt; [withAuditScope](./opensearch-dashboards.auditor.withauditscope.md)
+
+## Auditor.withAuditScope() method
+
+Add a high-level scope name for logged events. It helps to identify the root cause of low-level events.
+
+<b>Signature:</b>
+
+```typescript
+withAuditScope(name: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  name | string |  |
+
+<b>Returns:</b>
+
+void
+

source/opensearch-dashboards.auditorfactory.asscoped.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [opensearch-dashboards](./opensearch-dashboards.md) &gt; [AuditorFactory](./opensearch-dashboards.auditorfactory.md) &gt; [asScoped](./opensearch-dashboards.auditorfactory.asscoped.md)
+
+## AuditorFactory.asScoped() method
+
+<b>Signature:</b>
+
+```typescript
+asScoped(request: OpenSearchDashboardsRequest): Auditor;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  request | [OpenSearchDashboardsRequest](./opensearch-dashboards.opensearchdashboardsrequest.md) |  |
+
+<b>Returns:</b>
+
+[Auditor](./opensearch-dashboards.auditor.md)
+

source/opensearch-dashboards.auditorfactory.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [opensearch-dashboards](./opensearch-dashboards.md) &gt; [AuditorFactory](./opensearch-dashboards.auditorfactory.md)
+
+## AuditorFactory interface
+
+Creates [Auditor](./opensearch-dashboards.auditor.md) instance bound to the current user credentials.
+
+<b>Signature:</b>
+
+```typescript
+export interface AuditorFactory 
+```
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [asScoped(request)](./opensearch-dashboards.auditorfactory.asscoped.md) |  |
+