Updates API docs to add new NotFoundEsUnavailable SO repo error

elastic · Jul 29, 2021 · e1e93eb · e1e93eb
1 parent 2671098
commit e1e93eb
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 0 deletions.
diff --git a/...core-server.savedobjectserrorhelpers.creategenericnotfoundesunavailableerror.md b/...core-server.savedobjectserrorhelpers.creategenericnotfoundesunavailableerror.md
@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) &gt; [createGenericNotFoundEsUnavailableError](./kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfoundesunavailableerror.md)
+
+## SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError() method
+
+<b>Signature:</b>
+
+```typescript
+static createGenericNotFoundEsUnavailableError(type?: string | null, id?: string | null): DecoratedError;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| type | <code>string &#124; null</code> | |
+| id | <code>string &#124; null</code> | |
+
+<b>Returns:</b>
+
+`DecoratedError`
+
diff --git a/...ana-plugin-core-server.savedobjectserrorhelpers.isnotfoundesunavailableerror.md b/...ana-plugin-core-server.savedobjectserrorhelpers.isnotfoundesunavailableerror.md
@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) &gt; [isNotFoundEsUnavailableError](./kibana-plugin-core-server.savedobjectserrorhelpers.isnotfoundesunavailableerror.md)
+
+## SavedObjectsErrorHelpers.isNotFoundEsUnavailableError() method
+
+<b>Signature:</b>
+
+```typescript
+static isNotFoundEsUnavailableError(error: Error | DecoratedError): boolean;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| error | <code>Error &#124; DecoratedError</code> | |
+
+<b>Returns:</b>
+
+`boolean`
+
diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.md
@@ -18,6 +18,7 @@ export declare class SavedObjectsErrorHelpers
 | [createBadRequestError(reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.createbadrequesterror.md) | <code>static</code> | |
 | [createConflictError(type, id, reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.createconflicterror.md) | <code>static</code> | |
 | [createGenericNotFoundError(type, id)](./kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfounderror.md) | <code>static</code> | |
+| [createGenericNotFoundEsUnavailableError(type, id)](./kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfoundesunavailableerror.md) | <code>static</code> | |
 | [createIndexAliasNotFoundError(alias)](./kibana-plugin-core-server.savedobjectserrorhelpers.createindexaliasnotfounderror.md) | <code>static</code> | |
 | [createInvalidVersionError(versionInput)](./kibana-plugin-core-server.savedobjectserrorhelpers.createinvalidversionerror.md) | <code>static</code> | |
 | [createTooManyRequestsError(type, id)](./kibana-plugin-core-server.savedobjectserrorhelpers.createtoomanyrequestserror.md) | <code>static</code> | |
@@ -41,6 +42,7 @@ export declare class SavedObjectsErrorHelpers
 | [isInvalidVersionError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isinvalidversionerror.md) | <code>static</code> | |
 | [isNotAuthorizedError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isnotauthorizederror.md) | <code>static</code> | |
 | [isNotFoundError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isnotfounderror.md) | <code>static</code> | |
+| [isNotFoundEsUnavailableError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isnotfoundesunavailableerror.md) | <code>static</code> | |
 | [isRequestEntityTooLargeError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isrequestentitytoolargeerror.md) | <code>static</code> | |
 | [isSavedObjectsClientError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.issavedobjectsclienterror.md) | <code>static</code> | |
 | [isTooManyRequestsError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.istoomanyrequestserror.md) | <code>static</code> | |

diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md
@@ -2522,6 +2522,8 @@ export class SavedObjectsErrorHelpers {
  // (undocumented)
  static createGenericNotFoundError(type?: string | null, id?: string | null): DecoratedError;
  // (undocumented)
+ static createGenericNotFoundEsUnavailableError(type?: string | null, id?: string | null): DecoratedError;
+ // (undocumented)
  static createIndexAliasNotFoundError(alias: string): DecoratedError;
  // (undocumented)
  static createInvalidVersionError(versionInput?: string): DecoratedError;
@@ -2568,6 +2570,8 @@ export class SavedObjectsErrorHelpers {
  // (undocumented)
  static isNotFoundError(error: Error | DecoratedError): boolean;
  // (undocumented)
+ static isNotFoundEsUnavailableError(error: Error | DecoratedError): boolean;
+ // (undocumented)
  static isRequestEntityTooLargeError(error: Error | DecoratedError): boolean;
  // Warning: (ae-forgotten-export) The symbol "DecoratedError" needs to be exported by the entry point index.d.ts
  //