Changing some file names

x-pack/plugins/cases/README.md

@@ -266,4 +266,4 @@ For IBM Resilient connectors:
 [all-cases-modal-img]: images/all_cases_selector_modal.png
 [recent-cases-img]: images/recent_cases.png
 [case-view-img]: images/case_view.png
-[cases-client-api-docs]: docs/server/server_client_api.md
+[cases-client-api-docs]: docs/server/cases_client_api.md

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

@@ -19,5 +19,19 @@ yarn global add typedoc typedoc-plugin-markdown
 
 ```bash
 cd x-pack/plugins/cases/docs
-npx typedoc --options typedoc.json
+npx typedoc --options cases_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
+
+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/cases/docs/typedoc.json → x-pack/plugins/cases/docs/cases_client_typedoc.json

@@ -19,7 +19,7 @@
   "out": "server",
   "theme": "markdown",
   "plugin": "typedoc-plugin-markdown",
-  "entryDocument": "server_client_api.md",
+  "entryDocument": "cases_client_api.md",
   "readme": "none",
   "name": "Cases Client API Interface"
 }

x-pack/plugins/cases/docs/server/classes/client.casesclient.md

@@ -1,4 +1,4 @@
-[Cases Client API Interface](../server_client_api.md) / [client](../modules/client.md) / CasesClient
+[Cases Client API Interface](../cases_client_api.md) / [client](../modules/client.md) / CasesClient
 
 # Class: CasesClient
 
@@ -45,63 +45,63 @@ Client wrapper that contains accessor methods for individual entities within the
 
 **Returns:** [*CasesClient*](client.casesclient.md)
 
-Defined in: [client.ts:28](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/client.ts#L28)
+Defined in: [client.ts:28](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/client.ts#L28)
 
 ## Properties
 
 ### \_attachments
 
 • `Private` `Readonly` **\_attachments**: [*AttachmentsSubClient*](../interfaces/attachments_client.attachmentssubclient.md)
 
-Defined in: [client.ts:24](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/client.ts#L24)
+Defined in: [client.ts:24](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/client.ts#L24)
 
 ___
 
 ### \_cases
 
 • `Private` `Readonly` **\_cases**: [*CasesSubClient*](../interfaces/cases_client.casessubclient.md)
 
-Defined in: [client.ts:23](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/client.ts#L23)
+Defined in: [client.ts:23](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/client.ts#L23)
 
 ___
 
 ### \_casesClientInternal
 
 • `Private` `Readonly` **\_casesClientInternal**: *CasesClientInternal*
 
-Defined in: [client.ts:22](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/client.ts#L22)
+Defined in: [client.ts:22](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/client.ts#L22)
 
 ___
 
 ### \_configure
 
 • `Private` `Readonly` **\_configure**: [*ConfigureSubClient*](../interfaces/configure_client.configuresubclient.md)
 
-Defined in: [client.ts:27](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/client.ts#L27)
+Defined in: [client.ts:27](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/client.ts#L27)
 
 ___
 
 ### \_stats
 
 • `Private` `Readonly` **\_stats**: [*StatsSubClient*](../interfaces/stats_client.statssubclient.md)
 
-Defined in: [client.ts:28](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/client.ts#L28)
+Defined in: [client.ts:28](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/client.ts#L28)
 
 ___
 
 ### \_subCases
 
 • `Private` `Readonly` **\_subCases**: [*SubCasesClient*](../interfaces/sub_cases_client.subcasesclient.md)
 
-Defined in: [client.ts:26](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/client.ts#L26)
+Defined in: [client.ts:26](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/client.ts#L26)
 
 ___
 
 ### \_userActions
 
 • `Private` `Readonly` **\_userActions**: [*UserActionsSubClient*](../interfaces/user_actions_client.useractionssubclient.md)
 
-Defined in: [client.ts:25](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/client.ts#L25)
+Defined in: [client.ts:25](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/client.ts#L25)
 
 ## Accessors
 
@@ -113,7 +113,7 @@ Retrieves an interface for interacting with attachments (comments) entities.
 
 **Returns:** [*AttachmentsSubClient*](../interfaces/attachments_client.attachmentssubclient.md)
 
-Defined in: [client.ts:50](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/client.ts#L50)
+Defined in: [client.ts:50](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/client.ts#L50)
 
 ___
 
@@ -125,7 +125,7 @@ Retrieves an interface for interacting with cases entities.
 
 **Returns:** [*CasesSubClient*](../interfaces/cases_client.casessubclient.md)
 
-Defined in: [client.ts:43](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/client.ts#L43)
+Defined in: [client.ts:43](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/client.ts#L43)
 
 ___
 
@@ -137,7 +137,7 @@ Retrieves an interface for interacting with the configuration of external connec
 
 **Returns:** [*ConfigureSubClient*](../interfaces/configure_client.configuresubclient.md)
 
-Defined in: [client.ts:76](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/client.ts#L76)
+Defined in: [client.ts:76](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/client.ts#L76)
 
 ___
 
@@ -149,7 +149,7 @@ Retrieves an interface for retrieving statistics related to the cases entities.
 
 **Returns:** [*StatsSubClient*](../interfaces/stats_client.statssubclient.md)
 
-Defined in: [client.ts:83](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/client.ts#L83)
+Defined in: [client.ts:83](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/client.ts#L83)
 
 ___
 
@@ -163,7 +163,7 @@ Currently this functionality is disabled and will throw an error if this functio
 
 **Returns:** [*SubCasesClient*](../interfaces/sub_cases_client.subcasesclient.md)
 
-Defined in: [client.ts:66](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/client.ts#L66)
+Defined in: [client.ts:66](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/client.ts#L66)
 
 ___
 
@@ -175,4 +175,4 @@ Retrieves an interface for interacting with the user actions associated with the
 
 **Returns:** [*UserActionsSubClient*](../interfaces/user_actions_client.useractionssubclient.md)
 
-Defined in: [client.ts:57](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/client.ts#L57)
+Defined in: [client.ts:57](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/client.ts#L57)

x-pack/plugins/cases/docs/server/interfaces/attachments_add.addargs.md

@@ -1,4 +1,4 @@
-[Cases Client API Interface](../server_client_api.md) / [attachments/add](../modules/attachments_add.md) / AddArgs
+[Cases Client API Interface](../cases_client_api.md) / [attachments/add](../modules/attachments_add.md) / AddArgs
 
 # Interface: AddArgs
 
@@ -21,7 +21,7 @@ The arguments needed for creating a new attachment to a case.
 
 The case ID that this attachment will be associated with
 
-Defined in: [attachments/add.ts:308](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/attachments/add.ts#L308)
+Defined in: [attachments/add.ts:308](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/attachments/add.ts#L308)
 
 ___
 
@@ -31,4 +31,4 @@ ___
 
 The attachment values.
 
-Defined in: [attachments/add.ts:312](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/attachments/add.ts#L312)
+Defined in: [attachments/add.ts:312](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/attachments/add.ts#L312)

x-pack/plugins/cases/docs/server/interfaces/attachments_client.attachmentssubclient.md

@@ -1,4 +1,4 @@
-[Cases Client API Interface](../server_client_api.md) / [attachments/client](../modules/attachments_client.md) / AttachmentsSubClient
+[Cases Client API Interface](../cases_client_api.md) / [attachments/client](../modules/attachments_client.md) / AttachmentsSubClient
 
 # Interface: AttachmentsSubClient
 
@@ -34,7 +34,7 @@ Adds an attachment to a case.
 
 **Returns:** *Promise*<[*ICaseResponse*](typedoc_interfaces.icaseresponse.md)\>
 
-Defined in: [attachments/client.ts:25](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/attachments/client.ts#L25)
+Defined in: [attachments/client.ts:25](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/attachments/client.ts#L25)
 
 ___
 
@@ -52,7 +52,7 @@ Deletes a single attachment for a specific case.
 
 **Returns:** *Promise*<void\>
 
-Defined in: [attachments/client.ts:33](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/attachments/client.ts#L33)
+Defined in: [attachments/client.ts:33](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/attachments/client.ts#L33)
 
 ___
 
@@ -70,7 +70,7 @@ Deletes all attachments associated with a single case.
 
 **Returns:** *Promise*<void\>
 
-Defined in: [attachments/client.ts:29](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/attachments/client.ts#L29)
+Defined in: [attachments/client.ts:29](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/attachments/client.ts#L29)
 
 ___
 
@@ -88,7 +88,7 @@ Retrieves all comments matching the search criteria.
 
 **Returns:** *Promise*<[*ICommentsResponse*](typedoc_interfaces.icommentsresponse.md)\>
 
-Defined in: [attachments/client.ts:37](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/attachments/client.ts#L37)
+Defined in: [attachments/client.ts:37](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/attachments/client.ts#L37)
 
 ___
 
@@ -106,7 +106,7 @@ Retrieves a single attachment for a case.
 
 **Returns:** *Promise*<{ `comment`: *string* ; `owner`: *string* ; `type`: user  } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; }  } & { `id`: *string* ; `version`: *string*  } & { `alertId`: *string* \| *string*[] ; `index`: *string* \| *string*[] ; `owner`: *string* ; `rule`: { id: string \| null; name: string \| null; } ; `type`: alert \| generatedAlert  } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; }  } & { `id`: *string* ; `version`: *string*  }\>
 
-Defined in: [attachments/client.ts:45](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/attachments/client.ts#L45)
+Defined in: [attachments/client.ts:45](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/attachments/client.ts#L45)
 
 ___
 
@@ -124,7 +124,7 @@ Gets all attachments for a single case.
 
 **Returns:** *Promise*<[*IAllCommentsResponse*](typedoc_interfaces.iallcommentsresponse.md)\>
 
-Defined in: [attachments/client.ts:41](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/attachments/client.ts#L41)
+Defined in: [attachments/client.ts:41](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/attachments/client.ts#L41)
 
 ___
 
@@ -144,4 +144,4 @@ The request must include all fields for the attachment. Even the fields that are
 
 **Returns:** *Promise*<[*ICaseResponse*](typedoc_interfaces.icaseresponse.md)\>
 
-Defined in: [attachments/client.ts:51](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/attachments/client.ts#L51)
+Defined in: [attachments/client.ts:51](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/attachments/client.ts#L51)

x-pack/plugins/cases/docs/server/interfaces/attachments_delete.deleteallargs.md

@@ -1,4 +1,4 @@
-[Cases Client API Interface](../server_client_api.md) / [attachments/delete](../modules/attachments_delete.md) / DeleteAllArgs
+[Cases Client API Interface](../cases_client_api.md) / [attachments/delete](../modules/attachments_delete.md) / DeleteAllArgs
 
 # Interface: DeleteAllArgs
 
@@ -21,7 +21,7 @@ Parameters for deleting all comments of a case or sub case.
 
 The case ID to delete all attachments for
 
-Defined in: [attachments/delete.ts:26](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/attachments/delete.ts#L26)
+Defined in: [attachments/delete.ts:26](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/attachments/delete.ts#L26)
 
 ___
 
@@ -31,4 +31,4 @@ ___
 
 If specified the caseID will be ignored and this value will be used to find a sub case for deleting all the attachments
 
-Defined in: [attachments/delete.ts:30](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/attachments/delete.ts#L30)
+Defined in: [attachments/delete.ts:30](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/attachments/delete.ts#L30)

x-pack/plugins/cases/docs/server/interfaces/attachments_delete.deleteargs.md

@@ -1,4 +1,4 @@
-[Cases Client API Interface](../server_client_api.md) / [attachments/delete](../modules/attachments_delete.md) / DeleteArgs
+[Cases Client API Interface](../cases_client_api.md) / [attachments/delete](../modules/attachments_delete.md) / DeleteArgs
 
 # Interface: DeleteArgs
 
@@ -22,7 +22,7 @@ Parameters for deleting a single attachment of a case or sub case.
 
 The attachment ID to delete
 
-Defined in: [attachments/delete.ts:44](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/attachments/delete.ts#L44)
+Defined in: [attachments/delete.ts:44](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/attachments/delete.ts#L44)
 
 ___
 
@@ -32,7 +32,7 @@ ___
 
 The case ID to delete an attachment from
 
-Defined in: [attachments/delete.ts:40](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/attachments/delete.ts#L40)
+Defined in: [attachments/delete.ts:40](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/attachments/delete.ts#L40)
 
 ___
 
@@ -42,4 +42,4 @@ ___
 
 If specified the caseID will be ignored and this value will be used to find a sub case for deleting the attachment
 
-Defined in: [attachments/delete.ts:48](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/attachments/delete.ts#L48)
+Defined in: [attachments/delete.ts:48](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/attachments/delete.ts#L48)

x-pack/plugins/cases/docs/server/interfaces/attachments_get.findargs.md

@@ -1,4 +1,4 @@
-[Cases Client API Interface](../server_client_api.md) / [attachments/get](../modules/attachments_get.md) / FindArgs
+[Cases Client API Interface](../cases_client_api.md) / [attachments/get](../modules/attachments_get.md) / FindArgs
 
 # Interface: FindArgs
 
@@ -21,7 +21,7 @@ Parameters for finding attachments of a case
 
 The case ID for finding associated attachments
 
-Defined in: [attachments/get.ts:48](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/attachments/get.ts#L48)
+Defined in: [attachments/get.ts:48](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/attachments/get.ts#L48)
 
 ___
 
@@ -48,4 +48,4 @@ Optional parameters for filtering the returned attachments
 | `sortOrder` | *undefined* \| ``"desc"`` \| ``"asc"`` |
 | `subCaseId` | *undefined* \| *string* |
 
-Defined in: [attachments/get.ts:52](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/attachments/get.ts#L52)
+Defined in: [attachments/get.ts:52](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/attachments/get.ts#L52)

x-pack/plugins/cases/docs/server/interfaces/attachments_get.getallargs.md

@@ -1,4 +1,4 @@
-[Cases Client API Interface](../server_client_api.md) / [attachments/get](../modules/attachments_get.md) / GetAllArgs
+[Cases Client API Interface](../cases_client_api.md) / [attachments/get](../modules/attachments_get.md) / GetAllArgs
 
 # Interface: GetAllArgs
 
@@ -22,7 +22,7 @@ Parameters for retrieving all attachments of a case
 
 The case ID to retrieve all attachments for
 
-Defined in: [attachments/get.ts:62](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/attachments/get.ts#L62)
+Defined in: [attachments/get.ts:62](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/attachments/get.ts#L62)
 
 ___
 
@@ -32,7 +32,7 @@ ___
 
 Optionally include the attachments associated with a sub case
 
-Defined in: [attachments/get.ts:66](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/attachments/get.ts#L66)
+Defined in: [attachments/get.ts:66](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/attachments/get.ts#L66)
 
 ___
 
@@ -42,4 +42,4 @@ ___
 
 If included the case ID will be ignored and the attachments will be retrieved from the specified ID of the sub case
 
-Defined in: [attachments/get.ts:70](https://github.com/jonathan-buttner/kibana/blob/74ceeee50da/x-pack/plugins/cases/server/client/attachments/get.ts#L70)
+Defined in: [attachments/get.ts:70](https://github.com/jonathan-buttner/kibana/blob/1e8ae1f6ba4/x-pack/plugins/cases/server/client/attachments/get.ts#L70)