Skip to content

Commit c709983

Browse files
author
awstools
committed
feat(client-codeartifact): Add support for the Ruby package format.
1 parent f2e212c commit c709983

30 files changed

+143
-123
lines changed

Diff for: ‎clients/client-codeartifact/README.md

+12-10
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,12 @@ view of a package manager client. </p>
2121
<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
2222
versions</a>, each of which maps to a set of assets, or files. Repositories are
2323
polyglot, so a single repository can contain packages of any supported type. Each
24-
repository exposes endpoints for fetching and publishing packages using tools like the
25-
<b>
24+
repository exposes endpoints for fetching and publishing packages using tools such as the <b>
2625
<code>npm</code>
27-
</b> CLI, the Maven CLI (<b>
26+
</b> CLI or the Maven CLI (<b>
2827
<code>mvn</code>
29-
</b>), Python CLIs (<b>
30-
<code>pip</code>
31-
</b> and <code>twine</code>), NuGet CLIs (<code>nuget</code> and <code>dotnet</code>), and
32-
the Swift package manager (<b>
33-
<code>swift</code>
34-
</b>).</p>
28+
</b>). For a list of supported package managers, see the
29+
<a href="https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html">CodeArtifact User Guide</a>.</p>
3530
</li>
3631
<li>
3732
<p>
@@ -53,7 +48,9 @@ across their organization.</p>
5348
<li>
5449
<p>
5550
<b>Package</b>: A <i>package</i> is a bundle of software and the metadata required to
56-
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>
51+
resolve dependencies and install the software. CodeArtifact supports npm, PyPI, Maven, NuGet, Swift, Ruby, and generic package formats.
52+
For more information about the supported package formats and how to use CodeArtifact with them, see the
53+
<a href="https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html">CodeArtifact User Guide</a>.</p>
5754
<p>In CodeArtifact, a package consists of:</p>
5855
<ul>
5956
<li>
@@ -251,6 +248,11 @@ package format:
251248
</li>
252249
<li>
253250
<p>
251+
<code>ruby</code>
252+
</p>
253+
</li>
254+
<li>
255+
<p>
254256
<code>swift</code>
255257
</p>
256258
</li>

Diff for: ‎clients/client-codeartifact/src/Codeartifact.ts

+12-10
Original file line numberDiff line numberDiff line change
@@ -1075,17 +1075,12 @@ export interface Codeartifact {
10751075
* <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
10761076
* versions</a>, each of which maps to a set of assets, or files. Repositories are
10771077
* polyglot, so a single repository can contain packages of any supported type. Each
1078-
* repository exposes endpoints for fetching and publishing packages using tools like the
1079-
* <b>
1078+
* repository exposes endpoints for fetching and publishing packages using tools such as the <b>
10801079
* <code>npm</code>
1081-
* </b> CLI, the Maven CLI (<b>
1080+
* </b> CLI or the Maven CLI (<b>
10821081
* <code>mvn</code>
1083-
* </b>), Python CLIs (<b>
1084-
* <code>pip</code>
1085-
* </b> and <code>twine</code>), NuGet CLIs (<code>nuget</code> and <code>dotnet</code>), and
1086-
* the Swift package manager (<b>
1087-
* <code>swift</code>
1088-
* </b>).</p>
1082+
* </b>). For a list of supported package managers, see the
1083+
* <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html">CodeArtifact User Guide</a>.</p>
10891084
* </li>
10901085
* <li>
10911086
* <p>
@@ -1107,7 +1102,9 @@ export interface Codeartifact {
11071102
* <li>
11081103
* <p>
11091104
* <b>Package</b>: A <i>package</i> is a bundle of software and the metadata required to
1110-
* 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>
1105+
* resolve dependencies and install the software. CodeArtifact supports npm, PyPI, Maven, NuGet, Swift, Ruby, and generic package formats.
1106+
* For more information about the supported package formats and how to use CodeArtifact with them, see the
1107+
* <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html">CodeArtifact User Guide</a>.</p>
11111108
* <p>In CodeArtifact, a package consists of:</p>
11121109
* <ul>
11131110
* <li>
@@ -1305,6 +1302,11 @@ export interface Codeartifact {
13051302
* </li>
13061303
* <li>
13071304
* <p>
1305+
* <code>ruby</code>
1306+
* </p>
1307+
* </li>
1308+
* <li>
1309+
* <p>
13081310
* <code>swift</code>
13091311
* </p>
13101312
* </li>

Diff for: ‎clients/client-codeartifact/src/CodeartifactClient.ts

+12-10
Original file line numberDiff line numberDiff line change
@@ -502,17 +502,12 @@ export interface CodeartifactClientResolvedConfig extends CodeartifactClientReso
502502
* <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
503503
* versions</a>, each of which maps to a set of assets, or files. Repositories are
504504
* polyglot, so a single repository can contain packages of any supported type. Each
505-
* repository exposes endpoints for fetching and publishing packages using tools like the
506-
* <b>
505+
* repository exposes endpoints for fetching and publishing packages using tools such as the <b>
507506
* <code>npm</code>
508-
* </b> CLI, the Maven CLI (<b>
507+
* </b> CLI or the Maven CLI (<b>
509508
* <code>mvn</code>
510-
* </b>), Python CLIs (<b>
511-
* <code>pip</code>
512-
* </b> and <code>twine</code>), NuGet CLIs (<code>nuget</code> and <code>dotnet</code>), and
513-
* the Swift package manager (<b>
514-
* <code>swift</code>
515-
* </b>).</p>
509+
* </b>). For a list of supported package managers, see the
510+
* <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html">CodeArtifact User Guide</a>.</p>
516511
* </li>
517512
* <li>
518513
* <p>
@@ -534,7 +529,9 @@ export interface CodeartifactClientResolvedConfig extends CodeartifactClientReso
534529
* <li>
535530
* <p>
536531
* <b>Package</b>: A <i>package</i> is a bundle of software and the metadata required to
537-
* 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>
532+
* resolve dependencies and install the software. CodeArtifact supports npm, PyPI, Maven, NuGet, Swift, Ruby, and generic package formats.
533+
* For more information about the supported package formats and how to use CodeArtifact with them, see the
534+
* <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html">CodeArtifact User Guide</a>.</p>
538535
* <p>In CodeArtifact, a package consists of:</p>
539536
* <ul>
540537
* <li>
@@ -732,6 +729,11 @@ export interface CodeartifactClientResolvedConfig extends CodeartifactClientReso
732729
* </li>
733730
* <li>
734731
* <p>
732+
* <code>ruby</code>
733+
* </p>
734+
* </li>
735+
* <li>
736+
* <p>
735737
* <code>swift</code>
736738
* </p>
737739
* </li>

Diff for: ‎clients/client-codeartifact/src/commands/AssociateExternalConnectionCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ export interface AssociateExternalConnectionCommandOutput extends AssociateExter
6565
* // externalConnections: [ // RepositoryExternalConnectionInfoList
6666
* // { // RepositoryExternalConnectionInfo
6767
* // externalConnectionName: "STRING_VALUE",
68-
* // packageFormat: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift",
68+
* // packageFormat: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift",
6969
* // status: "Available",
7070
* // },
7171
* // ],

Diff for: ‎clients/client-codeartifact/src/commands/CopyPackageVersionsCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ export interface CopyPackageVersionsCommandOutput extends CopyPackageVersionsRes
4646
* domainOwner: "STRING_VALUE",
4747
* sourceRepository: "STRING_VALUE", // required
4848
* destinationRepository: "STRING_VALUE", // required
49-
* format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift", // required
49+
* format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift", // required
5050
* namespace: "STRING_VALUE",
5151
* package: "STRING_VALUE", // required
5252
* versions: [ // PackageVersionList

Diff for: ‎clients/client-codeartifact/src/commands/CreateRepositoryCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ export interface CreateRepositoryCommandOutput extends CreateRepositoryResult, _
7171
* // externalConnections: [ // RepositoryExternalConnectionInfoList
7272
* // { // RepositoryExternalConnectionInfo
7373
* // externalConnectionName: "STRING_VALUE",
74-
* // packageFormat: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift",
74+
* // packageFormat: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift",
7575
* // status: "Available",
7676
* // },
7777
* // ],

Diff for: ‎clients/client-codeartifact/src/commands/DeletePackageCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,15 +39,15 @@ export interface DeletePackageCommandOutput extends DeletePackageResult, __Metad
3939
* domain: "STRING_VALUE", // required
4040
* domainOwner: "STRING_VALUE",
4141
* repository: "STRING_VALUE", // required
42-
* format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift", // required
42+
* format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift", // required
4343
* namespace: "STRING_VALUE",
4444
* package: "STRING_VALUE", // required
4545
* };
4646
* const command = new DeletePackageCommand(input);
4747
* const response = await client.send(command);
4848
* // { // DeletePackageResult
4949
* // deletedPackage: { // PackageSummary
50-
* // format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift",
50+
* // format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift",
5151
* // namespace: "STRING_VALUE",
5252
* // package: "STRING_VALUE",
5353
* // originConfiguration: { // PackageOriginConfiguration

Diff for: ‎clients/client-codeartifact/src/commands/DeletePackageVersionsCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ export interface DeletePackageVersionsCommandOutput extends DeletePackageVersion
4242
* domain: "STRING_VALUE", // required
4343
* domainOwner: "STRING_VALUE",
4444
* repository: "STRING_VALUE", // required
45-
* format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift", // required
45+
* format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift", // required
4646
* namespace: "STRING_VALUE",
4747
* package: "STRING_VALUE", // required
4848
* versions: [ // PackageVersionList // required

Diff for: ‎clients/client-codeartifact/src/commands/DeleteRepositoryCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ export interface DeleteRepositoryCommandOutput extends DeleteRepositoryResult, _
5959
* // externalConnections: [ // RepositoryExternalConnectionInfoList
6060
* // { // RepositoryExternalConnectionInfo
6161
* // externalConnectionName: "STRING_VALUE",
62-
* // packageFormat: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift",
62+
* // packageFormat: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift",
6363
* // status: "Available",
6464
* // },
6565
* // ],

Diff for: ‎clients/client-codeartifact/src/commands/DescribePackageCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,15 @@ export interface DescribePackageCommandOutput extends DescribePackageResult, __M
4040
* domain: "STRING_VALUE", // required
4141
* domainOwner: "STRING_VALUE",
4242
* repository: "STRING_VALUE", // required
43-
* format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift", // required
43+
* format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift", // required
4444
* namespace: "STRING_VALUE",
4545
* package: "STRING_VALUE", // required
4646
* };
4747
* const command = new DescribePackageCommand(input);
4848
* const response = await client.send(command);
4949
* // { // DescribePackageResult
5050
* // package: { // PackageDescription
51-
* // format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift",
51+
* // format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift",
5252
* // namespace: "STRING_VALUE",
5353
* // name: "STRING_VALUE",
5454
* // originConfiguration: { // PackageOriginConfiguration

Diff for: ‎clients/client-codeartifact/src/commands/DescribePackageVersionCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ export interface DescribePackageVersionCommandOutput extends DescribePackageVers
4242
* domain: "STRING_VALUE", // required
4343
* domainOwner: "STRING_VALUE",
4444
* repository: "STRING_VALUE", // required
45-
* format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift", // required
45+
* format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift", // required
4646
* namespace: "STRING_VALUE",
4747
* package: "STRING_VALUE", // required
4848
* packageVersion: "STRING_VALUE", // required
@@ -51,7 +51,7 @@ export interface DescribePackageVersionCommandOutput extends DescribePackageVers
5151
* const response = await client.send(command);
5252
* // { // DescribePackageVersionResult
5353
* // packageVersion: { // PackageVersionDescription
54-
* // format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift",
54+
* // format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift",
5555
* // namespace: "STRING_VALUE",
5656
* // packageName: "STRING_VALUE",
5757
* // displayName: "STRING_VALUE",

Diff for: ‎clients/client-codeartifact/src/commands/DescribeRepositoryCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ export interface DescribeRepositoryCommandOutput extends DescribeRepositoryResul
6060
* // externalConnections: [ // RepositoryExternalConnectionInfoList
6161
* // { // RepositoryExternalConnectionInfo
6262
* // externalConnectionName: "STRING_VALUE",
63-
* // packageFormat: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift",
63+
* // packageFormat: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift",
6464
* // status: "Available",
6565
* // },
6666
* // ],

Diff for: ‎clients/client-codeartifact/src/commands/DisassociateExternalConnectionCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ export interface DisassociateExternalConnectionCommandOutput
6565
* // externalConnections: [ // RepositoryExternalConnectionInfoList
6666
* // { // RepositoryExternalConnectionInfo
6767
* // externalConnectionName: "STRING_VALUE",
68-
* // packageFormat: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift",
68+
* // packageFormat: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift",
6969
* // status: "Available",
7070
* // },
7171
* // ],

Diff for: ‎clients/client-codeartifact/src/commands/DisposePackageVersionsCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ export interface DisposePackageVersionsCommandOutput extends DisposePackageVersi
4949
* domain: "STRING_VALUE", // required
5050
* domainOwner: "STRING_VALUE",
5151
* repository: "STRING_VALUE", // required
52-
* format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift", // required
52+
* format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift", // required
5353
* namespace: "STRING_VALUE",
5454
* package: "STRING_VALUE", // required
5555
* versions: [ // PackageVersionList // required

Diff for: ‎clients/client-codeartifact/src/commands/GetAssociatedPackageGroupCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ export interface GetAssociatedPackageGroupCommandOutput extends GetAssociatedPac
4242
* const input = { // GetAssociatedPackageGroupRequest
4343
* domain: "STRING_VALUE", // required
4444
* domainOwner: "STRING_VALUE",
45-
* format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift", // required
45+
* format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift", // required
4646
* namespace: "STRING_VALUE",
4747
* package: "STRING_VALUE", // required
4848
* };

Diff for: ‎clients/client-codeartifact/src/commands/GetPackageVersionAssetCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ export interface GetPackageVersionAssetCommandOutput
5050
* domain: "STRING_VALUE", // required
5151
* domainOwner: "STRING_VALUE",
5252
* repository: "STRING_VALUE", // required
53-
* format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift", // required
53+
* format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift", // required
5454
* namespace: "STRING_VALUE",
5555
* package: "STRING_VALUE", // required
5656
* packageVersion: "STRING_VALUE", // required

Diff for: ‎clients/client-codeartifact/src/commands/GetPackageVersionReadmeCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -43,15 +43,15 @@ export interface GetPackageVersionReadmeCommandOutput extends GetPackageVersionR
4343
* domain: "STRING_VALUE", // required
4444
* domainOwner: "STRING_VALUE",
4545
* repository: "STRING_VALUE", // required
46-
* format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift", // required
46+
* format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift", // required
4747
* namespace: "STRING_VALUE",
4848
* package: "STRING_VALUE", // required
4949
* packageVersion: "STRING_VALUE", // required
5050
* };
5151
* const command = new GetPackageVersionReadmeCommand(input);
5252
* const response = await client.send(command);
5353
* // { // GetPackageVersionReadmeResult
54-
* // format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift",
54+
* // format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift",
5555
* // namespace: "STRING_VALUE",
5656
* // package: "STRING_VALUE",
5757
* // version: "STRING_VALUE",

Diff for: ‎clients/client-codeartifact/src/commands/GetRepositoryEndpointCommand.ts

+6-1
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,11 @@ export interface GetRepositoryEndpointCommandOutput extends GetRepositoryEndpoin
5959
* </li>
6060
* <li>
6161
* <p>
62+
* <code>ruby</code>
63+
* </p>
64+
* </li>
65+
* <li>
66+
* <p>
6267
* <code>swift</code>
6368
* </p>
6469
* </li>
@@ -73,7 +78,7 @@ export interface GetRepositoryEndpointCommandOutput extends GetRepositoryEndpoin
7378
* domain: "STRING_VALUE", // required
7479
* domainOwner: "STRING_VALUE",
7580
* repository: "STRING_VALUE", // required
76-
* format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift", // required
81+
* format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift", // required
7782
* };
7883
* const command = new GetRepositoryEndpointCommand(input);
7984
* const response = await client.send(command);

Diff for: ‎clients/client-codeartifact/src/commands/ListAssociatedPackagesCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ export interface ListAssociatedPackagesCommandOutput extends ListAssociatedPacka
4949
* // { // ListAssociatedPackagesResult
5050
* // packages: [ // AssociatedPackageList
5151
* // { // AssociatedPackage
52-
* // format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "swift",
52+
* // format: "npm" || "pypi" || "maven" || "nuget" || "generic" || "ruby" || "swift",
5353
* // namespace: "STRING_VALUE",
5454
* // package: "STRING_VALUE",
5555
* // associationType: "STRONG" || "WEAK",

0 commit comments

Comments
 (0)