Skip to content

Commit 53c37d3

Browse files
Update documentation
1 parent 542fa13 commit 53c37d3

1,854 files changed

Lines changed: 461443 additions & 120 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1.0/guides/building-models/gradle-plugin.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -469,12 +469,12 @@ <h1>Smithy Gradle Plugin<a class="headerlink" href="#smithy-gradle-plugin" title
469469
<span class="p">}</span>
470470

471471
<span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
472-
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-model:1.66.0&quot;</span><span class="p">)</span>
472+
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-model:1.67.0&quot;</span><span class="p">)</span>
473473

474474
<span class="w"> </span><span class="c1">// These are just examples of dependencies. This model has a dependency on</span>
475475
<span class="w"> </span><span class="c1">// a &quot;common&quot; model package and uses the external AWS traits.</span>
476476
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;com.foo.baz:foo-model-internal-common:1.0.0&quot;</span><span class="p">)</span>
477-
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-traits:1.66.0&quot;</span><span class="p">)</span>
477+
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-traits:1.67.0&quot;</span><span class="p">)</span>
478478
<span class="p">}</span>
479479
</pre></div>
480480
</div>
@@ -502,7 +502,7 @@ <h1>Smithy Gradle Plugin<a class="headerlink" href="#smithy-gradle-plugin" title
502502
<span class="w"> </span><span class="n">mavenCentral</span><span class="p">()</span>
503503
<span class="w"> </span><span class="p">}</span>
504504
<span class="w"> </span><span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
505-
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-traits:1.66.0&quot;</span><span class="p">)</span>
505+
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-traits:1.67.0&quot;</span><span class="p">)</span>
506506

507507
<span class="w"> </span><span class="c1">// Take a dependency on the internal model package. This</span>
508508
<span class="w"> </span><span class="c1">// dependency *must* be a buildscript only dependency to ensure</span>
@@ -526,12 +526,12 @@ <h1>Smithy Gradle Plugin<a class="headerlink" href="#smithy-gradle-plugin" title
526526
<span class="p">}</span>
527527

528528
<span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
529-
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-model:1.66.0&quot;</span><span class="p">)</span>
529+
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-model:1.67.0&quot;</span><span class="p">)</span>
530530

531531
<span class="w"> </span><span class="c1">// Any dependencies that the projected model needs must be (re)declared</span>
532532
<span class="w"> </span><span class="c1">// here. For example, let&#39;s assume that the smithy-aws-traits package is</span>
533533
<span class="w"> </span><span class="c1">// needed in the projected model too.</span>
534-
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-traits:1.66.0&quot;</span><span class="p">)</span>
534+
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-traits:1.67.0&quot;</span><span class="p">)</span>
535535
<span class="p">}</span>
536536
</pre></div>
537537
</div>
@@ -621,7 +621,7 @@ <h1>Smithy Gradle Plugin<a class="headerlink" href="#smithy-gradle-plugin" title
621621

622622
<span class="w"> </span><span class="c1">// This dependency is required in order to apply the &quot;openapi&quot;</span>
623623
<span class="w"> </span><span class="c1">// plugin in smithy-build.json</span>
624-
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-openapi:1.66.0&quot;</span><span class="p">)</span>
624+
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-openapi:1.67.0&quot;</span><span class="p">)</span>
625625
<span class="w"> </span><span class="p">}</span>
626626
<span class="p">}</span>
627627
</pre></div>

1.0/guides/converting-to-openapi.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -443,17 +443,17 @@ <h2>Converting to OpenAPI with smithy-build<a class="headerlink" href="#converti
443443

444444
<span class="n">buildscript</span><span class="w"> </span><span class="p">{</span>
445445
<span class="w"> </span><span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
446-
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-openapi:1.66.0&quot;</span><span class="p">)</span>
446+
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-openapi:1.67.0&quot;</span><span class="p">)</span>
447447
<span class="w"> </span><span class="c1">// The openapi plugin configured in the smithy-build.json example below</span>
448448
<span class="w"> </span><span class="c1">// uses the restJson1 protocol defined in the aws-traits package. This</span>
449449
<span class="w"> </span><span class="c1">// additional dependency must added to use that protocol.</span>
450-
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-traits:1.66.0&quot;</span><span class="p">)</span>
450+
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-traits:1.67.0&quot;</span><span class="p">)</span>
451451
<span class="w"> </span><span class="p">}</span>
452452
<span class="p">}</span>
453453

454454
<span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
455455
<span class="w"> </span><span class="c1">// The dependency for restJson1 is required here too.</span>
456-
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-traits:1.66.0&quot;</span><span class="p">)</span>
456+
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-traits:1.67.0&quot;</span><span class="p">)</span>
457457
<span class="p">}</span>
458458
</pre></div>
459459
</div>
@@ -479,7 +479,7 @@ <h2>Converting to OpenAPI with smithy-build<a class="headerlink" href="#converti
479479
</div>
480480
<div class="admonition important">
481481
<p class="admonition-title">Important</p>
482-
<p>A buildscript dependency on &quot;software.amazon.smithy:smithy-openapi:1.66.0&quot; is
482+
<p>A buildscript dependency on &quot;software.amazon.smithy:smithy-openapi:1.67.0&quot; is
483483
required in order for smithy-build to map the &quot;openapi&quot; plugin name to the
484484
correct Java library implementation.</p>
485485
</div>
@@ -1152,7 +1152,7 @@ <h2>Amazon API Gateway extensions<a class="headerlink" href="#amazon-api-gateway
11521152
<div class="code-block-caption"><span class="caption-text">build.gradle.kts</span><a class="headerlink" href="#apigateway-build-gradle" title="Link to this code"></a></div>
11531153
<div class="highlight-kotlin notranslate"><div class="highlight"><pre><span></span><span class="n">buildscript</span><span class="w"> </span><span class="p">{</span>
11541154
<span class="w"> </span><span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
1155-
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-apigateway-openapi:1.66.0&quot;</span><span class="p">)</span>
1155+
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-apigateway-openapi:1.67.0&quot;</span><span class="p">)</span>
11561156
<span class="w"> </span><span class="p">}</span>
11571157
<span class="p">}</span>
11581158
</pre></div>
@@ -1592,7 +1592,7 @@ <h2>Converting to OpenAPI with code<a class="headerlink" href="#converting-to-op
15921592
<div class="code-block-caption"><span class="caption-text">build.gradle.kts</span><a class="headerlink" href="#openapi-code-build-gradle" title="Link to this code"></a></div>
15931593
<div class="highlight-kotlin notranslate"><div class="highlight"><pre><span></span><span class="n">buildscript</span><span class="w"> </span><span class="p">{</span>
15941594
<span class="w"> </span><span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
1595-
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-openapi:1.66.0&quot;</span><span class="p">)</span>
1595+
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-openapi:1.67.0&quot;</span><span class="p">)</span>
15961596
<span class="w"> </span><span class="p">}</span>
15971597
<span class="p">}</span>
15981598
</pre></div>

1.0/guides/generating-cloudformation-resources.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -384,7 +384,7 @@ <h2>Generating Schemas with smithy-build<a class="headerlink" href="#generating-
384384

385385
<span class="n">buildscript</span><span class="w"> </span><span class="p">{</span>
386386
<span class="w"> </span><span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
387-
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-cloudformation:1.66.0&quot;</span><span class="p">)</span>
387+
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-cloudformation:1.67.0&quot;</span><span class="p">)</span>
388388
<span class="w"> </span><span class="p">}</span>
389389
<span class="p">}</span>
390390
</pre></div>
@@ -442,7 +442,7 @@ <h2>Generating Schemas with smithy-build<a class="headerlink" href="#generating-
442442
</div>
443443
<div class="admonition important">
444444
<p class="admonition-title">Important</p>
445-
<p>A buildscript dependency on &quot;software.amazon.smithy:smithy-aws-cloudformation:1.66.0&quot; is
445+
<p>A buildscript dependency on &quot;software.amazon.smithy:smithy-aws-cloudformation:1.67.0&quot; is
446446
required in order for smithy-build to map the &quot;cloudformation&quot; plugin name
447447
to the correct Java library implementation.</p>
448448
</div>
@@ -799,7 +799,7 @@ <h2>Generating Schemas with code<a class="headerlink" href="#generating-schemas-
799799
<div class="code-block-caption"><span class="caption-text">build.gradle.kts</span><a class="headerlink" href="#cfn-code-build-gradle" title="Link to this code"></a></div>
800800
<div class="highlight-kotlin notranslate"><div class="highlight"><pre><span></span><span class="n">buildscript</span><span class="w"> </span><span class="p">{</span>
801801
<span class="w"> </span><span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
802-
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-cloudformation:1.66.0&quot;</span><span class="p">)</span>
802+
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-cloudformation:1.67.0&quot;</span><span class="p">)</span>
803803
<span class="w"> </span><span class="p">}</span>
804804
<span class="p">}</span>
805805
</pre></div>
@@ -825,7 +825,7 @@ <h2>Generating Schemas with code<a class="headerlink" href="#generating-schemas-
825825
</div>
826826
<p>The conversion process is highly extensible through
827827
<code class="docutils literal notranslate"><span class="pre">software.amazon.smithy.aws.cloudformation.schema.fromsmithy.Smithy2CfnExtension</span></code>
828-
service providers. See the <a class="reference external" href="https://smithy.io/javadoc/1.66.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/Smithy2CfnExtension.html">Javadocs</a> for more information.</p>
828+
service providers. See the <a class="reference external" href="https://smithy.io/javadoc/1.67.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/Smithy2CfnExtension.html">Javadocs</a> for more information.</p>
829829
</section>
830830
</section>
831831

1.0/guides/model-linters.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -350,8 +350,8 @@ <h2>Linting overview<a class="headerlink" href="#linting-overview" title="Link t
350350
<p>The following example adds <code class="docutils literal notranslate"><span class="pre">smithy-linters</span></code> as a Gradle dependency
351351
to a <code class="docutils literal notranslate"><span class="pre">build.gradle.kts</span></code> file:</p>
352352
<div class="highlight-kotlin notranslate"><div class="highlight"><pre><span></span><span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
353-
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-model:1.66.0&quot;</span><span class="p">)</span>
354-
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-linters:1.66.0&quot;</span><span class="p">)</span>
353+
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-model:1.67.0&quot;</span><span class="p">)</span>
354+
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-linters:1.67.0&quot;</span><span class="p">)</span>
355355
<span class="p">}</span>
356356
</pre></div>
357357
</div>

1.0/quickstart.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -758,7 +758,7 @@ <h2>Building the Model<a class="headerlink" href="#building-the-model" title="Li
758758
<span class="p">}</span>
759759

760760
<span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
761-
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-model:1.66.0&quot;</span><span class="p">)</span>
761+
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-model:1.67.0&quot;</span><span class="p">)</span>
762762
<span class="p">}</span>
763763

764764
<span class="n">configure</span><span class="o">&lt;</span><span class="n">software</span><span class="p">.</span><span class="na">amazon</span><span class="p">.</span><span class="na">smithy</span><span class="p">.</span><span class="na">gradle</span><span class="p">.</span><span class="na">SmithyExtension</span><span class="o">&gt;</span><span class="w"> </span><span class="p">{</span>
@@ -819,7 +819,7 @@ <h2>Complete example<a class="headerlink" href="#complete-example" title="Link t
819819
<span class="p">}</span>
820820

821821
<span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
822-
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-model:1.66.0&quot;</span><span class="p">)</span>
822+
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-model:1.67.0&quot;</span><span class="p">)</span>
823823
<span class="p">}</span>
824824

825825
<span class="n">configure</span><span class="o">&lt;</span><span class="n">software</span><span class="p">.</span><span class="na">amazon</span><span class="p">.</span><span class="na">smithy</span><span class="p">.</span><span class="na">gradle</span><span class="p">.</span><span class="na">SmithyExtension</span><span class="o">&gt;</span><span class="w"> </span><span class="p">{</span>

1.0/spec/aws/aws-json-1_0-protocol.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@
351351
</dd>
352352
<dt>Value type</dt><dd><p>Structure</p>
353353
</dd>
354-
<dt>See</dt><dd><p><a class="reference external" href="https://github.com/smithy-lang/smithy/tree/1.66.0/smithy-aws-protocol-tests/model/awsJson1_0">Protocol tests</a></p>
354+
<dt>See</dt><dd><p><a class="reference external" href="https://github.com/smithy-lang/smithy/tree/1.67.0/smithy-aws-protocol-tests/model/awsJson1_0">Protocol tests</a></p>
355355
</dd>
356356
</dl>
357357
<p><code class="docutils literal notranslate"><span class="pre">aws.protocols#awsJson1_0</span></code> is a structure that supports the following

1.0/spec/aws/aws-json-1_1-protocol.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@
351351
</dd>
352352
<dt>Value type</dt><dd><p>Structure</p>
353353
</dd>
354-
<dt>See</dt><dd><p><a class="reference external" href="https://github.com/smithy-lang/smithy/tree/1.66.0/smithy-aws-protocol-tests/model/awsJson1_1">Protocol tests</a></p>
354+
<dt>See</dt><dd><p><a class="reference external" href="https://github.com/smithy-lang/smithy/tree/1.67.0/smithy-aws-protocol-tests/model/awsJson1_1">Protocol tests</a></p>
355355
</dd>
356356
</dl>
357357
<p><code class="docutils literal notranslate"><span class="pre">aws.protocols#awsJson1_1</span></code> is a structure that supports the following

1.0/spec/aws/aws-query-protocol.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1049,7 +1049,7 @@ <h3>XML shape serialization<a class="headerlink" href="#xml-shape-serialization"
10491049
</dd>
10501050
<dt>Value type</dt><dd><p>Annotation trait.</p>
10511051
</dd>
1052-
<dt>See</dt><dd><p><a class="reference external" href="https://github.com/smithy-lang/smithy/tree/1.66.0/smithy-aws-protocol-tests/model/awsQuery">Protocol tests</a></p>
1052+
<dt>See</dt><dd><p><a class="reference external" href="https://github.com/smithy-lang/smithy/tree/1.67.0/smithy-aws-protocol-tests/model/awsQuery">Protocol tests</a></p>
10531053
</dd>
10541054
</dl>
10551055
<div class="tab-set docutils">

1.0/spec/http-protocol-compliance-tests.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1007,7 +1007,7 @@ <h3>HTTP error response example<a class="headerlink" href="#http-error-response-
10071007
parameter lists. For example, parameters with 5 values for each key
10081008
will generate 5 tests in total.</p>
10091009
<p>Parameter values are substituted using the conventions described by
1010-
the documentation for <a class="reference external" href="https://smithy.io/javadoc/1.66.0/software/amazon/smithy/utils/CodeWriter.html">CodeWriter</a>. They are available as named
1010+
the documentation for <a class="reference external" href="https://smithy.io/javadoc/1.67.0/software/amazon/smithy/utils/CodeWriter.html">CodeWriter</a>. They are available as named
10111011
parameters, and implementations must support both the <code class="docutils literal notranslate"><span class="pre">L</span></code> and <code class="docutils literal notranslate"><span class="pre">S</span></code>
10121012
formatters.</p>
10131013
<div class="admonition note">

2.0/additional-specs/http-protocol-compliance-tests.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1066,7 +1066,7 @@ <h3>HTTP error response example<a class="headerlink" href="#http-error-response-
10661066
parameter lists. For example, parameters with 5 values for each key
10671067
will generate 5 tests in total.</p>
10681068
<p>Parameter values are substituted using the conventions described by
1069-
the documentation for <a class="reference external" href="https://smithy.io/javadoc/1.66.0/software/amazon/smithy/utils/CodeWriter.html">CodeWriter</a>. They are available as named
1069+
the documentation for <a class="reference external" href="https://smithy.io/javadoc/1.67.0/software/amazon/smithy/utils/CodeWriter.html">CodeWriter</a>. They are available as named
10701070
parameters, and implementations must support both the <code class="docutils literal notranslate"><span class="pre">L</span></code> and <code class="docutils literal notranslate"><span class="pre">S</span></code>
10711071
formatters.</p>
10721072
<div class="admonition note">

0 commit comments

Comments
 (0)