From 0db2ef8eadcaae4bb364569351487f8ca5b63b61 Mon Sep 17 00:00:00 2001 From: Rob Herley Date: Wed, 6 Dec 2023 20:24:33 +0000 Subject: [PATCH] clean up comments for better autogen docs --- packages/artifact/docs/generated/README.md | 3 +- .../classes/ArtifactNotFoundError.md | 2 +- .../classes/DefaultArtifactClient.md | 8 +-- .../generated/classes/FilesNotFoundError.md | 4 +- .../classes/GHESNotSupportedError.md | 2 +- .../generated/classes/InvalidResponseError.md | 2 +- .../docs/generated/interfaces/Artifact.md | 8 +-- .../generated/interfaces/ArtifactClient.md | 8 +-- .../interfaces/DownloadArtifactOptions.md | 2 +- .../interfaces/DownloadArtifactResponse.md | 2 +- .../docs/generated/interfaces/FindBy.md | 52 ------------------- .../docs/generated/interfaces/FindOptions.md | 15 +++++- .../interfaces/GetArtifactResponse.md | 2 +- .../interfaces/ListArtifactsOptions.md | 2 +- .../interfaces/ListArtifactsResponse.md | 2 +- .../interfaces/UploadArtifactOptions.md | 4 +- .../interfaces/UploadArtifactResponse.md | 4 +- .../src/internal/shared/interfaces.ts | 34 +++++++----- 18 files changed, 61 insertions(+), 95 deletions(-) delete mode 100644 packages/artifact/docs/generated/interfaces/FindBy.md diff --git a/packages/artifact/docs/generated/README.md b/packages/artifact/docs/generated/README.md index 4da5c7ed..a1244395 100644 --- a/packages/artifact/docs/generated/README.md +++ b/packages/artifact/docs/generated/README.md @@ -18,7 +18,6 @@ - [ArtifactClient](interfaces/ArtifactClient.md) - [DownloadArtifactOptions](interfaces/DownloadArtifactOptions.md) - [DownloadArtifactResponse](interfaces/DownloadArtifactResponse.md) -- [FindBy](interfaces/FindBy.md) - [FindOptions](interfaces/FindOptions.md) - [GetArtifactResponse](interfaces/GetArtifactResponse.md) - [ListArtifactsOptions](interfaces/ListArtifactsOptions.md) @@ -38,4 +37,4 @@ #### Defined in -[src/artifact.ts:7](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/artifact.ts#L7) +[src/artifact.ts:7](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/artifact.ts#L7) diff --git a/packages/artifact/docs/generated/classes/ArtifactNotFoundError.md b/packages/artifact/docs/generated/classes/ArtifactNotFoundError.md index dfa71a05..61700bb3 100644 --- a/packages/artifact/docs/generated/classes/ArtifactNotFoundError.md +++ b/packages/artifact/docs/generated/classes/ArtifactNotFoundError.md @@ -48,7 +48,7 @@ Error.constructor #### Defined in -[src/internal/shared/errors.ts:24](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/shared/errors.ts#L24) +[src/internal/shared/errors.ts:24](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/errors.ts#L24) ## Properties diff --git a/packages/artifact/docs/generated/classes/DefaultArtifactClient.md b/packages/artifact/docs/generated/classes/DefaultArtifactClient.md index 36706fa3..b93afc3e 100644 --- a/packages/artifact/docs/generated/classes/DefaultArtifactClient.md +++ b/packages/artifact/docs/generated/classes/DefaultArtifactClient.md @@ -60,7 +60,7 @@ single DownloadArtifactResponse object #### Defined in -[src/internal/client.ts:119](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/client.ts#L119) +[src/internal/client.ts:119](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/client.ts#L119) ___ @@ -95,7 +95,7 @@ If there are multiple artifacts with the same name in the same workflow run this #### Defined in -[src/internal/client.ts:193](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/client.ts#L193) +[src/internal/client.ts:193](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/client.ts#L193) ___ @@ -127,7 +127,7 @@ ListArtifactResponse object #### Defined in -[src/internal/client.ts:157](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/client.ts#L157) +[src/internal/client.ts:157](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/client.ts#L157) ___ @@ -158,4 +158,4 @@ single UploadArtifactResponse object #### Defined in -[src/internal/client.ts:94](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/client.ts#L94) +[src/internal/client.ts:94](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/client.ts#L94) diff --git a/packages/artifact/docs/generated/classes/FilesNotFoundError.md b/packages/artifact/docs/generated/classes/FilesNotFoundError.md index f4ce20da..c7d22014 100644 --- a/packages/artifact/docs/generated/classes/FilesNotFoundError.md +++ b/packages/artifact/docs/generated/classes/FilesNotFoundError.md @@ -49,7 +49,7 @@ Error.constructor #### Defined in -[src/internal/shared/errors.ts:4](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/shared/errors.ts#L4) +[src/internal/shared/errors.ts:4](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/errors.ts#L4) ## Properties @@ -59,7 +59,7 @@ Error.constructor #### Defined in -[src/internal/shared/errors.ts:2](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/shared/errors.ts#L2) +[src/internal/shared/errors.ts:2](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/errors.ts#L2) ___ diff --git a/packages/artifact/docs/generated/classes/GHESNotSupportedError.md b/packages/artifact/docs/generated/classes/GHESNotSupportedError.md index 8d2706f1..942ae287 100644 --- a/packages/artifact/docs/generated/classes/GHESNotSupportedError.md +++ b/packages/artifact/docs/generated/classes/GHESNotSupportedError.md @@ -48,7 +48,7 @@ Error.constructor #### Defined in -[src/internal/shared/errors.ts:31](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/shared/errors.ts#L31) +[src/internal/shared/errors.ts:31](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/errors.ts#L31) ## Properties diff --git a/packages/artifact/docs/generated/classes/InvalidResponseError.md b/packages/artifact/docs/generated/classes/InvalidResponseError.md index 7fceba89..1f6b0b5b 100644 --- a/packages/artifact/docs/generated/classes/InvalidResponseError.md +++ b/packages/artifact/docs/generated/classes/InvalidResponseError.md @@ -48,7 +48,7 @@ Error.constructor #### Defined in -[src/internal/shared/errors.ts:17](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/shared/errors.ts#L17) +[src/internal/shared/errors.ts:17](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/errors.ts#L17) ## Properties diff --git a/packages/artifact/docs/generated/interfaces/Artifact.md b/packages/artifact/docs/generated/interfaces/Artifact.md index 62a25e68..1597daa5 100644 --- a/packages/artifact/docs/generated/interfaces/Artifact.md +++ b/packages/artifact/docs/generated/interfaces/Artifact.md @@ -23,7 +23,7 @@ The time when the artifact was created #### Defined in -[src/internal/shared/interfaces.ts:123](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/shared/interfaces.ts#L123) +[src/internal/shared/interfaces.ts:123](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L123) ___ @@ -35,7 +35,7 @@ The ID of the artifact #### Defined in -[src/internal/shared/interfaces.ts:113](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/shared/interfaces.ts#L113) +[src/internal/shared/interfaces.ts:113](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L113) ___ @@ -47,7 +47,7 @@ The name of the artifact #### Defined in -[src/internal/shared/interfaces.ts:108](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/shared/interfaces.ts#L108) +[src/internal/shared/interfaces.ts:108](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L108) ___ @@ -59,4 +59,4 @@ The size of the artifact in bytes #### Defined in -[src/internal/shared/interfaces.ts:118](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/shared/interfaces.ts#L118) +[src/internal/shared/interfaces.ts:118](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L118) diff --git a/packages/artifact/docs/generated/interfaces/ArtifactClient.md b/packages/artifact/docs/generated/interfaces/ArtifactClient.md index 515f42c3..39f7d923 100644 --- a/packages/artifact/docs/generated/interfaces/ArtifactClient.md +++ b/packages/artifact/docs/generated/interfaces/ArtifactClient.md @@ -42,7 +42,7 @@ single DownloadArtifactResponse object #### Defined in -[src/internal/client.ts:84](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/client.ts#L84) +[src/internal/client.ts:84](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/client.ts#L84) ___ @@ -73,7 +73,7 @@ If there are multiple artifacts with the same name in the same workflow run this #### Defined in -[src/internal/client.ts:70](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/client.ts#L70) +[src/internal/client.ts:70](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/client.ts#L70) ___ @@ -101,7 +101,7 @@ ListArtifactResponse object #### Defined in -[src/internal/client.ts:52](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/client.ts#L52) +[src/internal/client.ts:52](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/client.ts#L52) ___ @@ -128,4 +128,4 @@ single UploadArtifactResponse object #### Defined in -[src/internal/client.ts:35](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/client.ts#L35) +[src/internal/client.ts:35](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/client.ts#L35) diff --git a/packages/artifact/docs/generated/interfaces/DownloadArtifactOptions.md b/packages/artifact/docs/generated/interfaces/DownloadArtifactOptions.md index 4728a355..8eff4d8f 100644 --- a/packages/artifact/docs/generated/interfaces/DownloadArtifactOptions.md +++ b/packages/artifact/docs/generated/interfaces/DownloadArtifactOptions.md @@ -20,4 +20,4 @@ Denotes where the artifact will be downloaded to. If not specified then the arti #### Defined in -[src/internal/shared/interfaces.ts:98](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/shared/interfaces.ts#L98) +[src/internal/shared/interfaces.ts:98](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L98) diff --git a/packages/artifact/docs/generated/interfaces/DownloadArtifactResponse.md b/packages/artifact/docs/generated/interfaces/DownloadArtifactResponse.md index 9cb87080..b2220364 100644 --- a/packages/artifact/docs/generated/interfaces/DownloadArtifactResponse.md +++ b/packages/artifact/docs/generated/interfaces/DownloadArtifactResponse.md @@ -20,4 +20,4 @@ The path where the artifact was downloaded to #### Defined in -[src/internal/shared/interfaces.ts:88](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/shared/interfaces.ts#L88) +[src/internal/shared/interfaces.ts:88](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L88) diff --git a/packages/artifact/docs/generated/interfaces/FindBy.md b/packages/artifact/docs/generated/interfaces/FindBy.md deleted file mode 100644 index 3cd6a060..00000000 --- a/packages/artifact/docs/generated/interfaces/FindBy.md +++ /dev/null @@ -1,52 +0,0 @@ -[@actions/artifact](../README.md) / FindBy - -# Interface: FindBy - -## Table of contents - -### Properties - -- [repositoryName](FindBy.md#repositoryname) -- [repositoryOwner](FindBy.md#repositoryowner) -- [token](FindBy.md#token) -- [workflowRunId](FindBy.md#workflowrunid) - -## Properties - -### repositoryName - -• **repositoryName**: `string` - -#### Defined in - -[src/internal/shared/interfaces.ts:140](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/shared/interfaces.ts#L140) - -___ - -### repositoryOwner - -• **repositoryOwner**: `string` - -#### Defined in - -[src/internal/shared/interfaces.ts:138](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/shared/interfaces.ts#L138) - -___ - -### token - -• **token**: `string` - -#### Defined in - -[src/internal/shared/interfaces.ts:134](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/shared/interfaces.ts#L134) - -___ - -### workflowRunId - -• **workflowRunId**: `number` - -#### Defined in - -[src/internal/shared/interfaces.ts:136](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/shared/interfaces.ts#L136) diff --git a/packages/artifact/docs/generated/interfaces/FindOptions.md b/packages/artifact/docs/generated/interfaces/FindOptions.md index 33653ca6..68f56706 100644 --- a/packages/artifact/docs/generated/interfaces/FindOptions.md +++ b/packages/artifact/docs/generated/interfaces/FindOptions.md @@ -12,8 +12,19 @@ ### findBy -• `Optional` **findBy**: [`FindBy`](FindBy.md) +• `Optional` **findBy**: `Object` + +The criteria for finding Artifact(s) out of the scope of the current run. + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `repositoryName` | `string` | Repository owner (eg. 'toolkit') | +| `repositoryOwner` | `string` | Repository owner (eg. 'actions') | +| `token` | `string` | Token with actions:read permissions | +| `workflowRunId` | `number` | WorkflowRun of the artifact(s) to lookup | #### Defined in -[src/internal/shared/interfaces.ts:128](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/shared/interfaces.ts#L128) +[src/internal/shared/interfaces.ts:131](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L131) diff --git a/packages/artifact/docs/generated/interfaces/GetArtifactResponse.md b/packages/artifact/docs/generated/interfaces/GetArtifactResponse.md index 64f8c4fb..f4d56509 100644 --- a/packages/artifact/docs/generated/interfaces/GetArtifactResponse.md +++ b/packages/artifact/docs/generated/interfaces/GetArtifactResponse.md @@ -20,4 +20,4 @@ Metadata about the artifact that was found #### Defined in -[src/internal/shared/interfaces.ts:57](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/shared/interfaces.ts#L57) +[src/internal/shared/interfaces.ts:57](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L57) diff --git a/packages/artifact/docs/generated/interfaces/ListArtifactsOptions.md b/packages/artifact/docs/generated/interfaces/ListArtifactsOptions.md index a9b7f1f1..27e3d5f7 100644 --- a/packages/artifact/docs/generated/interfaces/ListArtifactsOptions.md +++ b/packages/artifact/docs/generated/interfaces/ListArtifactsOptions.md @@ -21,4 +21,4 @@ In the case of reruns, this can be useful to avoid duplicates #### Defined in -[src/internal/shared/interfaces.ts:68](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/shared/interfaces.ts#L68) +[src/internal/shared/interfaces.ts:68](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L68) diff --git a/packages/artifact/docs/generated/interfaces/ListArtifactsResponse.md b/packages/artifact/docs/generated/interfaces/ListArtifactsResponse.md index 83519ff3..836cbbd7 100644 --- a/packages/artifact/docs/generated/interfaces/ListArtifactsResponse.md +++ b/packages/artifact/docs/generated/interfaces/ListArtifactsResponse.md @@ -20,4 +20,4 @@ A list of artifacts that were found #### Defined in -[src/internal/shared/interfaces.ts:78](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/shared/interfaces.ts#L78) +[src/internal/shared/interfaces.ts:78](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L78) diff --git a/packages/artifact/docs/generated/interfaces/UploadArtifactOptions.md b/packages/artifact/docs/generated/interfaces/UploadArtifactOptions.md index 8870c0be..acff13df 100644 --- a/packages/artifact/docs/generated/interfaces/UploadArtifactOptions.md +++ b/packages/artifact/docs/generated/interfaces/UploadArtifactOptions.md @@ -28,7 +28,7 @@ For large files that are not easily compressed, a value of 0 is recommended for #### Defined in -[src/internal/shared/interfaces.ts:47](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/shared/interfaces.ts#L47) +[src/internal/shared/interfaces.ts:47](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L47) ___ @@ -52,4 +52,4 @@ input of 0 assumes default retention setting. #### Defined in -[src/internal/shared/interfaces.ts:36](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/shared/interfaces.ts#L36) +[src/internal/shared/interfaces.ts:36](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L36) diff --git a/packages/artifact/docs/generated/interfaces/UploadArtifactResponse.md b/packages/artifact/docs/generated/interfaces/UploadArtifactResponse.md index 154e222d..574366fc 100644 --- a/packages/artifact/docs/generated/interfaces/UploadArtifactResponse.md +++ b/packages/artifact/docs/generated/interfaces/UploadArtifactResponse.md @@ -22,7 +22,7 @@ This ID can be used as input to other APIs to download, delete or get more infor #### Defined in -[src/internal/shared/interfaces.ts:14](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/shared/interfaces.ts#L14) +[src/internal/shared/interfaces.ts:14](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L14) ___ @@ -34,4 +34,4 @@ Total size of the artifact in bytes. Not provided if no artifact was uploaded #### Defined in -[src/internal/shared/interfaces.ts:8](https://github.com/actions/toolkit/blob/207747e/packages/artifact/src/internal/shared/interfaces.ts#L8) +[src/internal/shared/interfaces.ts:8](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L8) diff --git a/packages/artifact/src/internal/shared/interfaces.ts b/packages/artifact/src/internal/shared/interfaces.ts index ce38f806..c661721e 100644 --- a/packages/artifact/src/internal/shared/interfaces.ts +++ b/packages/artifact/src/internal/shared/interfaces.ts @@ -125,17 +125,25 @@ export interface Artifact { // FindOptions are for fetching Artifact(s) out of the scope of the current run. export interface FindOptions { - findBy?: FindBy -} - -// FindBy are the criteria for finding Artifact(s) out of the scope of the current run. -export interface FindBy { - // Token with actions:read permissions - token: string - // WorkflowRun of the artifact(s) to lookup - workflowRunId: number - // Repository owner - repositoryOwner: string - // Repository name - repositoryName: string + /** + * The criteria for finding Artifact(s) out of the scope of the current run. + */ + findBy?: { + /** + * Token with actions:read permissions + */ + token: string + /** + * WorkflowRun of the artifact(s) to lookup + */ + workflowRunId: number + /** + * Repository owner (eg. 'actions') + */ + repositoryOwner: string + /** + * Repository owner (eg. 'toolkit') + */ + repositoryName: string + } }