feat(client-codeartifact): Add support for the Ruby package format.

aws · Apr 30, 2024 · c709983 · c709983
1 parent f2e212c
commit c709983
Show file tree

Hide file tree

Showing 30 changed files with 143 additions and 123 deletions.
diff --git a/clients/client-codeartifact/README.md b/clients/client-codeartifact/README.md
@@ -21,17 +21,12 @@ view of a package manager client. </p>
 <b>Repository</b>: A CodeArtifact repository contains a set of <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html#welcome-concepts-package-version">package
 versions</a>, each of which maps to a set of assets, or files. Repositories are
 polyglot, so a single repository can contain packages of any supported type. Each
-repository exposes endpoints for fetching and publishing packages using tools like the
-<b>
+repository exposes endpoints for fetching and publishing packages using tools such as the <b>
 <code>npm</code>
-</b> CLI, the Maven CLI (<b>
+</b> CLI or the Maven CLI (<b>
 <code>mvn</code>
-</b>), Python CLIs (<b>
-<code>pip</code>
-</b> and <code>twine</code>), NuGet CLIs (<code>nuget</code> and <code>dotnet</code>), and
-the Swift package manager (<b>
-<code>swift</code>
-</b>).</p>
+</b>). For a list of supported package managers, see the
+<a href="https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html">CodeArtifact User Guide</a>.</p>
 </li>
 <li>
 <p>
@@ -53,7 +48,9 @@ across their organization.</p>
 <li>
 <p>
 <b>Package</b>: A <i>package</i> is a bundle of software and the metadata required to
-resolve dependencies and install the software. CodeArtifact supports <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-npm.html">npm</a>, <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-python.html">PyPI</a>, <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-maven">Maven</a>, <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-nuget">NuGet</a>, <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-swift">Swift</a>, and <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-generic">generic</a> package formats.</p>
+resolve dependencies and install the software. CodeArtifact supports npm, PyPI, Maven, NuGet, Swift, Ruby, and generic package formats.
+For more information about the supported package formats and how to use CodeArtifact with them, see the
+<a href="https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html">CodeArtifact User Guide</a>.</p>
 <p>In CodeArtifact, a package consists of:</p>
 <ul>
 <li>
@@ -251,6 +248,11 @@ package format:
 </li>
 <li>
 <p>
+<code>ruby</code>
+</p>
+</li>
+<li>
+<p>
 <code>swift</code>
 </p>
 </li>

diff --git a/clients/client-codeartifact/src/Codeartifact.ts b/clients/client-codeartifact/src/Codeartifact.ts
@@ -1075,17 +1075,12 @@ export interface Codeartifact {
  *                   <b>Repository</b>: A CodeArtifact repository contains a set of <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html#welcome-concepts-package-version">package
  *             versions</a>, each of which maps to a set of assets, or files. Repositories are
  *           polyglot, so a single repository can contain packages of any supported type. Each
- *           repository exposes endpoints for fetching and publishing packages using tools like the
- *             <b>
+ *           repository exposes endpoints for fetching and publishing packages using tools such as the <b>
  *                      <code>npm</code>
- *                   </b> CLI, the Maven CLI (<b>
+ *                   </b> CLI or the Maven CLI (<b>
  *                      <code>mvn</code>
- *                   </b>), Python CLIs (<b>
- *                      <code>pip</code>
- *                   </b> and <code>twine</code>), NuGet CLIs (<code>nuget</code> and <code>dotnet</code>), and
- *           the Swift package manager (<b>
- *                      <code>swift</code>
- *                   </b>).</p>
+ *                   </b>). For a list of supported package managers, see the
+ *           <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html">CodeArtifact User Guide</a>.</p>
  *             </li>
  *             <li>
  *                <p>
@@ -1107,7 +1102,9 @@ export interface Codeartifact {
  *             <li>
  *                <p>
  *                   <b>Package</b>: A <i>package</i> is a bundle of software and the metadata required to
- *           resolve dependencies and install the software. CodeArtifact supports <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-npm.html">npm</a>, <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-python.html">PyPI</a>, <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-maven">Maven</a>, <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-nuget">NuGet</a>, <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-swift">Swift</a>, and <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-generic">generic</a> package formats.</p>
+ *           resolve dependencies and install the software. CodeArtifact supports npm, PyPI, Maven, NuGet, Swift, Ruby, and generic package formats.
+ *         For more information about the supported package formats and how to use CodeArtifact with them, see the
+ *           <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html">CodeArtifact User Guide</a>.</p>
  *                <p>In CodeArtifact, a package consists of:</p>
  *                <ul>
  *                   <li>
@@ -1305,6 +1302,11 @@ export interface Codeartifact {
  *                   </li>
  *                   <li>
  *                      <p>
+ *                         <code>ruby</code>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
  *                         <code>swift</code>
  *                      </p>
  *                   </li>

diff --git a/clients/client-codeartifact/src/CodeartifactClient.ts b/clients/client-codeartifact/src/CodeartifactClient.ts
@@ -502,17 +502,12 @@ export interface CodeartifactClientResolvedConfig extends CodeartifactClientReso
  *                   <b>Repository</b>: A CodeArtifact repository contains a set of <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html#welcome-concepts-package-version">package
  *             versions</a>, each of which maps to a set of assets, or files. Repositories are
  *           polyglot, so a single repository can contain packages of any supported type. Each
- *           repository exposes endpoints for fetching and publishing packages using tools like the
- *             <b>
+ *           repository exposes endpoints for fetching and publishing packages using tools such as the <b>
  *                      <code>npm</code>
- *                   </b> CLI, the Maven CLI (<b>
+ *                   </b> CLI or the Maven CLI (<b>
  *                      <code>mvn</code>
- *                   </b>), Python CLIs (<b>
- *                      <code>pip</code>
- *                   </b> and <code>twine</code>), NuGet CLIs (<code>nuget</code> and <code>dotnet</code>), and
- *           the Swift package manager (<b>
- *                      <code>swift</code>
- *                   </b>).</p>
+ *                   </b>). For a list of supported package managers, see the
+ *           <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html">CodeArtifact User Guide</a>.</p>
  *             </li>
  *             <li>
  *                <p>
@@ -534,7 +529,9 @@ export interface CodeartifactClientResolvedConfig extends CodeartifactClientReso
  *             <li>
  *                <p>
  *                   <b>Package</b>: A <i>package</i> is a bundle of software and the metadata required to
- *           resolve dependencies and install the software. CodeArtifact supports <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-npm.html">npm</a>, <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-python.html">PyPI</a>, <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-maven">Maven</a>, <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-nuget">NuGet</a>, <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-swift">Swift</a>, and <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-generic">generic</a> package formats.</p>
+ *           resolve dependencies and install the software. CodeArtifact supports npm, PyPI, Maven, NuGet, Swift, Ruby, and generic package formats.
+ *         For more information about the supported package formats and how to use CodeArtifact with them, see the
+ *           <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html">CodeArtifact User Guide</a>.</p>
  *                <p>In CodeArtifact, a package consists of:</p>
  *                <ul>
  *                   <li>
@@ -732,6 +729,11 @@ export interface CodeartifactClientResolvedConfig extends CodeartifactClientReso
  *                   </li>
  *                   <li>
  *                      <p>
+ *                         <code>ruby</code>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
  *                         <code>swift</code>
  *                      </p>
  *                   </li>

diff --git a/clients/client-codeartifact/src/commands/AssociateExternalConnectionCommand.ts b/clients/client-codeartifact/src/commands/AssociateExternalConnectionCommand.ts
@@ -65,7 +65,7 @@ export interface AssociateExternalConnectionCommandOutput extends AssociateExter
  * //     externalConnections: [ // RepositoryExternalConnectionInfoList
  * //       { // RepositoryExternalConnectionInfo
  * //         externalConnectionName: "STRING_VALUE",
- * //         packageFormat: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift",
+ * //         packageFormat: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift",
  * //         status: "Available",
  * //       },
  * //     ],

diff --git a/clients/client-codeartifact/src/commands/CopyPackageVersionsCommand.ts b/clients/client-codeartifact/src/commands/CopyPackageVersionsCommand.ts
@@ -46,7 +46,7 @@ export interface CopyPackageVersionsCommandOutput extends CopyPackageVersionsRes
  *   domainOwner: "STRING_VALUE",
  *   sourceRepository: "STRING_VALUE", // required
  *   destinationRepository: "STRING_VALUE", // required
- *   format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift", // required
+ *   format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift", // required
  *   namespace: "STRING_VALUE",
  *   package: "STRING_VALUE", // required
  *   versions: [ // PackageVersionList

diff --git a/clients/client-codeartifact/src/commands/CreateRepositoryCommand.ts b/clients/client-codeartifact/src/commands/CreateRepositoryCommand.ts
@@ -71,7 +71,7 @@ export interface CreateRepositoryCommandOutput extends CreateRepositoryResult, _
  * //     externalConnections: [ // RepositoryExternalConnectionInfoList
  * //       { // RepositoryExternalConnectionInfo
  * //         externalConnectionName: "STRING_VALUE",
- * //         packageFormat: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift",
+ * //         packageFormat: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift",
  * //         status: "Available",
  * //       },
  * //     ],

diff --git a/clients/client-codeartifact/src/commands/DeletePackageCommand.ts b/clients/client-codeartifact/src/commands/DeletePackageCommand.ts
@@ -39,15 +39,15 @@ export interface DeletePackageCommandOutput extends DeletePackageResult, __Metad
  *   domain: "STRING_VALUE", // required
  *   domainOwner: "STRING_VALUE",
  *   repository: "STRING_VALUE", // required
- *   format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift", // required
+ *   format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift", // required
  *   namespace: "STRING_VALUE",
  *   package: "STRING_VALUE", // required
  * };
  * const command = new DeletePackageCommand(input);
  * const response = await client.send(command);
  * // { // DeletePackageResult
  * //   deletedPackage: { // PackageSummary
- * //     format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift",
+ * //     format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift",
  * //     namespace: "STRING_VALUE",
  * //     package: "STRING_VALUE",
  * //     originConfiguration: { // PackageOriginConfiguration

diff --git a/clients/client-codeartifact/src/commands/DeletePackageVersionsCommand.ts b/clients/client-codeartifact/src/commands/DeletePackageVersionsCommand.ts
@@ -42,7 +42,7 @@ export interface DeletePackageVersionsCommandOutput extends DeletePackageVersion
  *   domain: "STRING_VALUE", // required
  *   domainOwner: "STRING_VALUE",
  *   repository: "STRING_VALUE", // required
- *   format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift", // required
+ *   format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift", // required
  *   namespace: "STRING_VALUE",
  *   package: "STRING_VALUE", // required
  *   versions: [ // PackageVersionList // required

diff --git a/clients/client-codeartifact/src/commands/DeleteRepositoryCommand.ts b/clients/client-codeartifact/src/commands/DeleteRepositoryCommand.ts
@@ -59,7 +59,7 @@ export interface DeleteRepositoryCommandOutput extends DeleteRepositoryResult, _
  * //     externalConnections: [ // RepositoryExternalConnectionInfoList
  * //       { // RepositoryExternalConnectionInfo
  * //         externalConnectionName: "STRING_VALUE",
- * //         packageFormat: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift",
+ * //         packageFormat: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift",
  * //         status: "Available",
  * //       },
  * //     ],

diff --git a/clients/client-codeartifact/src/commands/DescribePackageCommand.ts b/clients/client-codeartifact/src/commands/DescribePackageCommand.ts
@@ -40,15 +40,15 @@ export interface DescribePackageCommandOutput extends DescribePackageResult, __M
  *   domain: "STRING_VALUE", // required
  *   domainOwner: "STRING_VALUE",
  *   repository: "STRING_VALUE", // required
- *   format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift", // required
+ *   format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift", // required
  *   namespace: "STRING_VALUE",
  *   package: "STRING_VALUE", // required
  * };
  * const command = new DescribePackageCommand(input);
  * const response = await client.send(command);
  * // { // DescribePackageResult
  * //   package: { // PackageDescription
- * //     format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift",
+ * //     format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift",
  * //     namespace: "STRING_VALUE",
  * //     name: "STRING_VALUE",
  * //     originConfiguration: { // PackageOriginConfiguration

diff --git a/clients/client-codeartifact/src/commands/DescribePackageVersionCommand.ts b/clients/client-codeartifact/src/commands/DescribePackageVersionCommand.ts
@@ -42,7 +42,7 @@ export interface DescribePackageVersionCommandOutput extends DescribePackageVers
  *   domain: "STRING_VALUE", // required
  *   domainOwner: "STRING_VALUE",
  *   repository: "STRING_VALUE", // required
- *   format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift", // required
+ *   format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift", // required
  *   namespace: "STRING_VALUE",
  *   package: "STRING_VALUE", // required
  *   packageVersion: "STRING_VALUE", // required
@@ -51,7 +51,7 @@ export interface DescribePackageVersionCommandOutput extends DescribePackageVers
  * const response = await client.send(command);
  * // { // DescribePackageVersionResult
  * //   packageVersion: { // PackageVersionDescription
- * //     format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift",
+ * //     format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift",
  * //     namespace: "STRING_VALUE",
  * //     packageName: "STRING_VALUE",
  * //     displayName: "STRING_VALUE",

diff --git a/clients/client-codeartifact/src/commands/DescribeRepositoryCommand.ts b/clients/client-codeartifact/src/commands/DescribeRepositoryCommand.ts
@@ -60,7 +60,7 @@ export interface DescribeRepositoryCommandOutput extends DescribeRepositoryResul
  * //     externalConnections: [ // RepositoryExternalConnectionInfoList
  * //       { // RepositoryExternalConnectionInfo
  * //         externalConnectionName: "STRING_VALUE",
- * //         packageFormat: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift",
+ * //         packageFormat: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift",
  * //         status: "Available",
  * //       },
  * //     ],

diff --git a/clients/client-codeartifact/src/commands/DisassociateExternalConnectionCommand.ts b/clients/client-codeartifact/src/commands/DisassociateExternalConnectionCommand.ts
@@ -65,7 +65,7 @@ export interface DisassociateExternalConnectionCommandOutput
  * //     externalConnections: [ // RepositoryExternalConnectionInfoList
  * //       { // RepositoryExternalConnectionInfo
  * //         externalConnectionName: "STRING_VALUE",
- * //         packageFormat: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift",
+ * //         packageFormat: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift",
  * //         status: "Available",
  * //       },
  * //     ],

diff --git a/clients/client-codeartifact/src/commands/DisposePackageVersionsCommand.ts b/clients/client-codeartifact/src/commands/DisposePackageVersionsCommand.ts
@@ -49,7 +49,7 @@ export interface DisposePackageVersionsCommandOutput extends DisposePackageVersi
  *   domain: "STRING_VALUE", // required
  *   domainOwner: "STRING_VALUE",
  *   repository: "STRING_VALUE", // required
- *   format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift", // required
+ *   format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift", // required
  *   namespace: "STRING_VALUE",
  *   package: "STRING_VALUE", // required
  *   versions: [ // PackageVersionList // required

diff --git a/clients/client-codeartifact/src/commands/GetAssociatedPackageGroupCommand.ts b/clients/client-codeartifact/src/commands/GetAssociatedPackageGroupCommand.ts
@@ -42,7 +42,7 @@ export interface GetAssociatedPackageGroupCommandOutput extends GetAssociatedPac
  * const input = { // GetAssociatedPackageGroupRequest
  *   domain: "STRING_VALUE", // required
  *   domainOwner: "STRING_VALUE",
- *   format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift", // required
+ *   format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift", // required
  *   namespace: "STRING_VALUE",
  *   package: "STRING_VALUE", // required
  * };

diff --git a/clients/client-codeartifact/src/commands/GetPackageVersionAssetCommand.ts b/clients/client-codeartifact/src/commands/GetPackageVersionAssetCommand.ts
@@ -50,7 +50,7 @@ export interface GetPackageVersionAssetCommandOutput
  *   domain: "STRING_VALUE", // required
  *   domainOwner: "STRING_VALUE",
  *   repository: "STRING_VALUE", // required
- *   format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift", // required
+ *   format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift", // required
  *   namespace: "STRING_VALUE",
  *   package: "STRING_VALUE", // required
  *   packageVersion: "STRING_VALUE", // required

diff --git a/clients/client-codeartifact/src/commands/GetPackageVersionReadmeCommand.ts b/clients/client-codeartifact/src/commands/GetPackageVersionReadmeCommand.ts
@@ -43,15 +43,15 @@ export interface GetPackageVersionReadmeCommandOutput extends GetPackageVersionR
  *   domain: "STRING_VALUE", // required
  *   domainOwner: "STRING_VALUE",
  *   repository: "STRING_VALUE", // required
- *   format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift", // required
+ *   format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift", // required
  *   namespace: "STRING_VALUE",
  *   package: "STRING_VALUE", // required
  *   packageVersion: "STRING_VALUE", // required
  * };
  * const command = new GetPackageVersionReadmeCommand(input);
  * const response = await client.send(command);
  * // { // GetPackageVersionReadmeResult
- * //   format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift",
+ * //   format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift",
  * //   namespace: "STRING_VALUE",
  * //   package: "STRING_VALUE",
  * //   version: "STRING_VALUE",

diff --git a/clients/client-codeartifact/src/commands/GetRepositoryEndpointCommand.ts b/clients/client-codeartifact/src/commands/GetRepositoryEndpointCommand.ts
@@ -59,6 +59,11 @@ export interface GetRepositoryEndpointCommandOutput extends GetRepositoryEndpoin
  *             </li>
  *             <li>
  *                <p>
+ *                   <code>ruby</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
  *                   <code>swift</code>
  *                </p>
  *             </li>
@@ -73,7 +78,7 @@ export interface GetRepositoryEndpointCommandOutput extends GetRepositoryEndpoin
  *   domain: "STRING_VALUE", // required
  *   domainOwner: "STRING_VALUE",
  *   repository: "STRING_VALUE", // required
- *   format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift", // required
+ *   format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift", // required
  * };
  * const command = new GetRepositoryEndpointCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-codeartifact/src/commands/ListAssociatedPackagesCommand.ts b/clients/client-codeartifact/src/commands/ListAssociatedPackagesCommand.ts
@@ -49,7 +49,7 @@ export interface ListAssociatedPackagesCommandOutput extends ListAssociatedPacka
  * // { // ListAssociatedPackagesResult
  * //   packages: [ // AssociatedPackageList
  * //     { // AssociatedPackage
- * //       format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift",
+ * //       format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift",
  * //       namespace: "STRING_VALUE",
  * //       package: "STRING_VALUE",
  * //       associationType: "STRONG" || "WEAK",