Skip to content

Commit 0b3654d

Browse files
Update documentation
1 parent 7adab84 commit 0b3654d

1,794 files changed

Lines changed: 443013 additions & 124 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
@@ -434,12 +434,12 @@ <h1>Smithy Gradle Plugin<a class="headerlink" href="#smithy-gradle-plugin" title
434434
<span class="p">}</span>
435435

436436
<span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
437-
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-model:1.61.0&quot;</span><span class="p">)</span>
437+
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-model:1.62.0&quot;</span><span class="p">)</span>
438438

439439
<span class="w"> </span><span class="c1">// These are just examples of dependencies. This model has a dependency on</span>
440440
<span class="w"> </span><span class="c1">// a &quot;common&quot; model package and uses the external AWS traits.</span>
441441
<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>
442-
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-traits:1.61.0&quot;</span><span class="p">)</span>
442+
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-traits:1.62.0&quot;</span><span class="p">)</span>
443443
<span class="p">}</span>
444444
</pre></div>
445445
</div>
@@ -469,7 +469,7 @@ <h1>Smithy Gradle Plugin<a class="headerlink" href="#smithy-gradle-plugin" title
469469
<span class="w"> </span><span class="n">mavenCentral</span><span class="p">()</span>
470470
<span class="w"> </span><span class="p">}</span>
471471
<span class="w"> </span><span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
472-
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-traits:1.61.0&quot;</span><span class="p">)</span>
472+
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-traits:1.62.0&quot;</span><span class="p">)</span>
473473

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

495495
<span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
496-
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-model:1.61.0&quot;</span><span class="p">)</span>
496+
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-model:1.62.0&quot;</span><span class="p">)</span>
497497

498498
<span class="w"> </span><span class="c1">// Any dependencies that the projected model needs must be (re)declared</span>
499499
<span class="w"> </span><span class="c1">// here. For example, let&#39;s assume that the smithy-aws-traits package is</span>
500500
<span class="w"> </span><span class="c1">// needed in the projected model too.</span>
501-
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-traits:1.61.0&quot;</span><span class="p">)</span>
501+
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-traits:1.62.0&quot;</span><span class="p">)</span>
502502
<span class="p">}</span>
503503
</pre></div>
504504
</div>
@@ -598,7 +598,7 @@ <h1>Smithy Gradle Plugin<a class="headerlink" href="#smithy-gradle-plugin" title
598598

599599
<span class="w"> </span><span class="c1">// This dependency is required in order to apply the &quot;openapi&quot;</span>
600600
<span class="w"> </span><span class="c1">// plugin in smithy-build.json</span>
601-
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-openapi:1.61.0&quot;</span><span class="p">)</span>
601+
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-openapi:1.62.0&quot;</span><span class="p">)</span>
602602
<span class="w"> </span><span class="p">}</span>
603603
<span class="p">}</span>
604604
</pre></div>

1.0/guides/converting-to-openapi.html

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

408408
<span class="n">buildscript</span><span class="w"> </span><span class="p">{</span>
409409
<span class="w"> </span><span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
410-
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-openapi:1.61.0&quot;</span><span class="p">)</span>
410+
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-openapi:1.62.0&quot;</span><span class="p">)</span>
411411
<span class="w"> </span><span class="c1">// The openapi plugin configured in the smithy-build.json example below</span>
412412
<span class="w"> </span><span class="c1">// uses the restJson1 protocol defined in the aws-traits package. This</span>
413413
<span class="w"> </span><span class="c1">// additional dependency must added to use that protocol.</span>
414-
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-traits:1.61.0&quot;</span><span class="p">)</span>
414+
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-traits:1.62.0&quot;</span><span class="p">)</span>
415415
<span class="w"> </span><span class="p">}</span>
416416
<span class="p">}</span>
417417

418418
<span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
419419
<span class="w"> </span><span class="c1">// The dependency for restJson1 is required here too.</span>
420-
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-traits:1.61.0&quot;</span><span class="p">)</span>
420+
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-traits:1.62.0&quot;</span><span class="p">)</span>
421421
<span class="p">}</span>
422422
</pre></div>
423423
</div>
@@ -443,7 +443,7 @@ <h2>Converting to OpenAPI with smithy-build<a class="headerlink" href="#converti
443443
</div>
444444
<div class="admonition important">
445445
<p class="first admonition-title">Important</p>
446-
<p class="last">A buildscript dependency on &quot;software.amazon.smithy:smithy-openapi:1.61.0&quot; is
446+
<p class="last">A buildscript dependency on &quot;software.amazon.smithy:smithy-openapi:1.62.0&quot; is
447447
required in order for smithy-build to map the &quot;openapi&quot; plugin name to the
448448
correct Java library implementation.</p>
449449
</div>
@@ -1116,7 +1116,7 @@ <h2>Amazon API Gateway extensions<a class="headerlink" href="#amazon-api-gateway
11161116
<div class="code-block-caption"><span class="caption-text">build.gradle.kts</span><a class="headerlink" href="#apigateway-build-gradle" title="Permalink to this code">#</a></div>
11171117
<div class="highlight-kotlin notranslate"><div class="highlight"><pre><span></span><span class="n">buildscript</span><span class="w"> </span><span class="p">{</span>
11181118
<span class="w"> </span><span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
1119-
<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.61.0&quot;</span><span class="p">)</span>
1119+
<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.62.0&quot;</span><span class="p">)</span>
11201120
<span class="w"> </span><span class="p">}</span>
11211121
<span class="p">}</span>
11221122
</pre></div>
@@ -1555,7 +1555,7 @@ <h2>Converting to OpenAPI with code<a class="headerlink" href="#converting-to-op
15551555
<div class="code-block-caption"><span class="caption-text">build.gradle.kts</span><a class="headerlink" href="#openapi-code-build-gradle" title="Permalink to this code">#</a></div>
15561556
<div class="highlight-kotlin notranslate"><div class="highlight"><pre><span></span><span class="n">buildscript</span><span class="w"> </span><span class="p">{</span>
15571557
<span class="w"> </span><span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
1558-
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-openapi:1.61.0&quot;</span><span class="p">)</span>
1558+
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-openapi:1.62.0&quot;</span><span class="p">)</span>
15591559
<span class="w"> </span><span class="p">}</span>
15601560
<span class="p">}</span>
15611561
</pre></div>

1.0/guides/generating-cloudformation-resources.html

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

344344
<span class="n">buildscript</span><span class="w"> </span><span class="p">{</span>
345345
<span class="w"> </span><span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
346-
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-cloudformation:1.61.0&quot;</span><span class="p">)</span>
346+
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-cloudformation:1.62.0&quot;</span><span class="p">)</span>
347347
<span class="w"> </span><span class="p">}</span>
348348
<span class="p">}</span>
349349
</pre></div>
@@ -401,7 +401,7 @@ <h2>Generating Schemas with smithy-build<a class="headerlink" href="#generating-
401401
</div>
402402
<div class="admonition important">
403403
<p class="first admonition-title">Important</p>
404-
<p class="last">A buildscript dependency on &quot;software.amazon.smithy:smithy-aws-cloudformation:1.61.0&quot; is
404+
<p class="last">A buildscript dependency on &quot;software.amazon.smithy:smithy-aws-cloudformation:1.62.0&quot; is
405405
required in order for smithy-build to map the &quot;cloudformation&quot; plugin name
406406
to the correct Java library implementation.</p>
407407
</div>
@@ -756,7 +756,7 @@ <h2>Generating Schemas with code<a class="headerlink" href="#generating-schemas-
756756
<div class="code-block-caption"><span class="caption-text">build.gradle.kts</span><a class="headerlink" href="#cfn-code-build-gradle" title="Permalink to this code">#</a></div>
757757
<div class="highlight-kotlin notranslate"><div class="highlight"><pre><span></span><span class="n">buildscript</span><span class="w"> </span><span class="p">{</span>
758758
<span class="w"> </span><span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
759-
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-cloudformation:1.61.0&quot;</span><span class="p">)</span>
759+
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-cloudformation:1.62.0&quot;</span><span class="p">)</span>
760760
<span class="w"> </span><span class="p">}</span>
761761
<span class="p">}</span>
762762
</pre></div>
@@ -782,7 +782,7 @@ <h2>Generating Schemas with code<a class="headerlink" href="#generating-schemas-
782782
</div>
783783
<p>The conversion process is highly extensible through
784784
<code class="docutils literal notranslate"><span class="pre">software.amazon.smithy.aws.cloudformation.schema.fromsmithy.Smithy2CfnExtension</span></code>
785-
service providers. See the <a class="reference external" href="https://smithy.io/javadoc/1.61.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/Smithy2CfnExtension.html">Javadocs</a> for more information.</p>
785+
service providers. See the <a class="reference external" href="https://smithy.io/javadoc/1.62.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/Smithy2CfnExtension.html">Javadocs</a> for more information.</p>
786786
</div>
787787
</div>
788788

1.0/guides/model-linters.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -311,8 +311,8 @@ <h2>Linting overview<a class="headerlink" href="#linting-overview" title="Permal
311311
to a <code class="docutils literal notranslate"><span class="pre">build.gradle.kts</span></code> file:</p>
312312
<div class="sphinx-tabs docutils container">
313313
<div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-0-S290bGlu" aria-selected="true" class="sphinx-tabs-tab code-tab group-tab" id="tab-0-S290bGlu" name="S290bGlu" role="tab" tabindex="0">Kotlin</button></div><div aria-labelledby="tab-0-S290bGlu" class="sphinx-tabs-panel code-tab group-tab" id="panel-0-S290bGlu" name="S290bGlu" role="tabpanel" tabindex="0"><div class="highlight-kotlin notranslate"><div class="highlight"><pre><span></span><span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
314-
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-model:1.61.0&quot;</span><span class="p">)</span>
315-
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-linters:1.61.0&quot;</span><span class="p">)</span>
314+
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-model:1.62.0&quot;</span><span class="p">)</span>
315+
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-linters:1.62.0&quot;</span><span class="p">)</span>
316316
<span class="p">}</span>
317317
</pre></div>
318318
</div>

1.0/quickstart.html

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

719719
<span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
720-
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-model:1.61.0&quot;</span><span class="p">)</span>
720+
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-model:1.62.0&quot;</span><span class="p">)</span>
721721
<span class="p">}</span>
722722

723723
<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>
@@ -778,7 +778,7 @@ <h2>Complete example<a class="headerlink" href="#complete-example" title="Permal
778778
<span class="p">}</span>
779779

780780
<span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
781-
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-model:1.61.0&quot;</span><span class="p">)</span>
781+
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-model:1.62.0&quot;</span><span class="p">)</span>
782782
<span class="p">}</span>
783783

784784
<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/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@
308308
responses with JSON documents.</dd>
309309
<dt>Trait selector</dt><dd><code class="docutils literal notranslate"><span class="pre">service</span></code></dd>
310310
<dt>Value type</dt><dd>Structure</dd>
311-
<dt>See</dt><dd><a class="reference external" href="https://github.com/smithy-lang/smithy/tree/1.61.0/smithy-aws-protocol-tests/model/awsJson1_0">Protocol tests</a></dd>
311+
<dt>See</dt><dd><a class="reference external" href="https://github.com/smithy-lang/smithy/tree/1.62.0/smithy-aws-protocol-tests/model/awsJson1_0">Protocol tests</a></dd>
312312
</dl>
313313
<p><code class="docutils literal notranslate"><span class="pre">aws.protocols#awsJson1_0</span></code> is a structure that supports the following
314314
members:</p>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@
308308
responses with JSON documents.</dd>
309309
<dt>Trait selector</dt><dd><code class="docutils literal notranslate"><span class="pre">service</span></code></dd>
310310
<dt>Value type</dt><dd>Structure</dd>
311-
<dt>See</dt><dd><a class="reference external" href="https://github.com/smithy-lang/smithy/tree/1.61.0/smithy-aws-protocol-tests/model/awsJson1_1">Protocol tests</a></dd>
311+
<dt>See</dt><dd><a class="reference external" href="https://github.com/smithy-lang/smithy/tree/1.62.0/smithy-aws-protocol-tests/model/awsJson1_1">Protocol tests</a></dd>
312312
</dl>
313313
<p><code class="docutils literal notranslate"><span class="pre">aws.protocols#awsJson1_1</span></code> is a structure that supports the following
314314
members:</p>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1008,7 +1008,7 @@ <h3>XML shape serialization<a class="headerlink" href="#xml-shape-serialization"
10081008
<p><em>Service shapes with the xmlNamespace trait</em></p>
10091009
</dd>
10101010
<dt>Value type</dt><dd>Annotation trait.</dd>
1011-
<dt>See</dt><dd><a class="reference external" href="https://github.com/smithy-lang/smithy/tree/1.61.0/smithy-aws-protocol-tests/model/awsQuery">Protocol tests</a></dd>
1011+
<dt>See</dt><dd><a class="reference external" href="https://github.com/smithy-lang/smithy/tree/1.62.0/smithy-aws-protocol-tests/model/awsQuery">Protocol tests</a></dd>
10121012
</dl>
10131013
<div class="sphinx-tabs docutils container">
10141014
<div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-0-U21pdGh5" aria-selected="true" class="sphinx-tabs-tab code-tab group-tab" id="tab-0-U21pdGh5" name="U21pdGh5" role="tab" tabindex="0">Smithy</button><button aria-controls="panel-0-SlNPTg==" aria-selected="false" class="sphinx-tabs-tab code-tab group-tab" id="tab-0-SlNPTg==" name="SlNPTg==" role="tab" tabindex="-1">JSON</button></div><div aria-labelledby="tab-0-U21pdGh5" class="sphinx-tabs-panel code-tab group-tab" id="panel-0-U21pdGh5" name="U21pdGh5" role="tabpanel" tabindex="0"><div class="highlight-smithy notranslate"><div class="highlight"><pre><span></span><span class="kd">namespace </span><span class="nc">smithy.example</span>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -954,7 +954,7 @@ <h3>HTTP error response example<a class="headerlink" href="#http-error-response-
954954
parameter lists. For example, parameters with 5 values for each key
955955
will generate 5 tests in total.</p>
956956
<p>Parameter values are substituted using the conventions described by
957-
the documentation for <a class="reference external" href="https://smithy.io/javadoc/1.61.0/software/amazon/smithy/utils/CodeWriter.html">CodeWriter</a>. They are available as named
957+
the documentation for <a class="reference external" href="https://smithy.io/javadoc/1.62.0/software/amazon/smithy/utils/CodeWriter.html">CodeWriter</a>. They are available as named
958958
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>
959959
formatters.</p>
960960
<div class="last admonition note">

0 commit comments

Comments
 (0)