Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@sugmanue
sugmanue committed Mar 22, 2024
1 parent 66f4484 commit 48e3837
Show file tree
Hide file tree
Showing 1,613 changed files with 384,509 additions and 579 deletions.
47 changes: 23 additions & 24 deletions 1.0/_static/basic.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,16 @@ div.body p, div.body dd, div.body li, div.body blockquote {
a.headerlink {
visibility: hidden;
}
a.brackets:before,
span.brackets > a:before{
content: "[";
}

a.brackets:after,
span.brackets > a:after {
content: "]";
}


h1:hover > a.headerlink,
h2:hover > a.headerlink,
Expand Down Expand Up @@ -324,15 +334,11 @@ aside.sidebar {
p.sidebar-title {
font-weight: bold;
}
nav.contents,
aside.topic,
div.admonition, div.topic, blockquote {
clear: left;
}

/* -- topics ---------------------------------------------------------------- */
nav.contents,
aside.topic,
div.topic {
border: 1px solid #ccc;
padding: 7px;
Expand Down Expand Up @@ -371,17 +377,13 @@ div.body p.centered {

div.sidebar > :last-child,
aside.sidebar > :last-child,
nav.contents > :last-child,
aside.topic > :last-child,
div.topic > :last-child,
div.admonition > :last-child {
margin-bottom: 0;
}

div.sidebar::after,
aside.sidebar::after,
nav.contents::after,
aside.topic::after,
div.topic::after,
div.admonition::after,
blockquote::after {
Expand Down Expand Up @@ -606,26 +608,19 @@ ol.simple p,
ul.simple p {
margin-bottom: 0;
}
aside.footnote > span,
div.citation > span {
dl.footnote > dt,
dl.citation > dt {
float: left;
margin-right: 0.5em;
}
aside.footnote > span:last-of-type,
div.citation > span:last-of-type {
padding-right: 0.5em;
}
aside.footnote > p {
margin-left: 2em;
}
div.citation > p {
margin-left: 4em;
}
aside.footnote > p:last-of-type,
div.citation > p:last-of-type {

dl.footnote > dd,
dl.citation > dd {
margin-bottom: 0em;
}
aside.footnote > p:last-of-type:after,
div.citation > p:last-of-type:after {

dl.footnote > dd:after,
dl.citation > dd:after {
content: "";
clear: both;
}
Expand All @@ -641,6 +636,10 @@ dl.field-list > dt {
padding-left: 0.5em;
padding-right: 5px;
}
dl.field-list > dt:after {
content: ":";
}


dl.field-list > dd {
padding-left: 0.5em;
Expand Down
48 changes: 24 additions & 24 deletions 1.0/guides/building-models/build-config.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ <h1>smithy-build<a class="headerlink" href="#smithy-build" title="Permalink to t
what projections of the model to create.</p>
<p>The configuration file accepts the following properties:</p>
<div class="table-wrapper colwidths-given docutils container">
<table border="1" class="docutils align-default">
<table border="1" class="colwidths-given docutils align-default">
<colgroup>
<col width="10%" />
<col width="20%" />
Expand Down Expand Up @@ -419,7 +419,7 @@ <h1>smithy-build<a class="headerlink" href="#smithy-build" title="Permalink to t
property. Projection names MUST match the following pattern: <code class="docutils literal notranslate"><span class="pre">^[A-Za-z0-9\-_.]+$</span></code>.</p>
<p>A projection accepts the following configuration:</p>
<div class="table-wrapper colwidths-given docutils container">
<table border="1" class="docutils align-default">
<table border="1" class="colwidths-given docutils align-default">
<colgroup>
<col width="10%" />
<col width="20%" />
Expand Down Expand Up @@ -488,7 +488,7 @@ <h1>smithy-build<a class="headerlink" href="#smithy-build" title="Permalink to t
Transforms are applied to the model, in order.</p>
<p>A transform accepts the following configuration:</p>
<div class="table-wrapper colwidths-given docutils container">
<table border="1" class="docutils align-default">
<table border="1" class="colwidths-given docutils align-default">
<colgroup>
<col width="10%" />
<col width="20%" />
Expand Down Expand Up @@ -516,7 +516,7 @@ <h1>smithy-build<a class="headerlink" href="#smithy-build" title="Permalink to t
<span id="apply-transform"></span><h3>apply<a class="headerlink" href="#apply" title="Permalink to this heading">#</a></h3>
<p>Applies the transforms defined in the given projection names.</p>
<div class="table-wrapper colwidths-given docutils container">
<table border="1" class="docutils align-default">
<table border="1" class="colwidths-given docutils align-default">
<colgroup>
<col width="10%" />
<col width="20%" />
Expand Down Expand Up @@ -572,7 +572,7 @@ <h1>smithy-build<a class="headerlink" href="#smithy-build" title="Permalink to t
<span id="id4"></span><h3>changeStringEnumsToEnumShapes<a class="headerlink" href="#changestringenumstoenumshapes" title="Permalink to this heading">#</a></h3>
<p>Changes string shapes with enum traits into enum shapes.</p>
<div class="table-wrapper colwidths-given docutils container">
<table border="1" class="docutils align-default">
<table border="1" class="colwidths-given docutils align-default">
<colgroup>
<col width="10%" />
<col width="20%" />
Expand Down Expand Up @@ -624,7 +624,7 @@ <h1>smithy-build<a class="headerlink" href="#smithy-build" title="Permalink to t
<span id="id5"></span><h3>changeTypes<a class="headerlink" href="#changetypes" title="Permalink to this heading">#</a></h3>
<p>Changes the types of shapes.</p>
<div class="table-wrapper colwidths-given docutils container">
<table border="1" class="docutils align-default">
<table border="1" class="colwidths-given docutils align-default">
<colgroup>
<col width="10%" />
<col width="20%" />
Expand Down Expand Up @@ -689,7 +689,7 @@ <h1>smithy-build<a class="headerlink" href="#smithy-build" title="Permalink to t
<p>Removes shapes if they are tagged with one or more of the given <code class="docutils literal notranslate"><span class="pre">tags</span></code> via
the <a class="reference internal" href="../../spec/core/documentation-traits.html#tags-trait"><span class="std std-ref">tags trait</span></a>.</p>
<div class="table-wrapper colwidths-given docutils container">
<table border="1" class="docutils align-default">
<table border="1" class="colwidths-given docutils align-default">
<colgroup>
<col width="10%" />
<col width="20%" />
Expand Down Expand Up @@ -737,7 +737,7 @@ <h1>smithy-build<a class="headerlink" href="#smithy-build" title="Permalink to t
<span id="excludeshapesbytrait-transform"></span><h3>excludeShapesByTrait<a class="headerlink" href="#excludeshapesbytrait" title="Permalink to this heading">#</a></h3>
<p>Removes shapes if they are marked with one or more specific traits.</p>
<div class="table-wrapper colwidths-given docutils container">
<table border="1" class="docutils align-default">
<table border="1" class="colwidths-given docutils align-default">
<colgroup>
<col width="10%" />
<col width="20%" />
Expand Down Expand Up @@ -785,7 +785,7 @@ <h1>smithy-build<a class="headerlink" href="#smithy-build" title="Permalink to t
<p>Removes shapes that are not tagged with at least one of the given <code class="docutils literal notranslate"><span class="pre">tags</span></code>
via the <a class="reference internal" href="../../spec/core/documentation-traits.html#tags-trait"><span class="std std-ref">tags trait</span></a>.</p>
<div class="table-wrapper colwidths-given docutils container">
<table border="1" class="docutils align-default">
<table border="1" class="colwidths-given docutils align-default">
<colgroup>
<col width="10%" />
<col width="20%" />
Expand Down Expand Up @@ -834,7 +834,7 @@ <h1>smithy-build<a class="headerlink" href="#smithy-build" title="Permalink to t
<p>Filters out shapes that are not part of one of the given <a class="reference internal" href="../../spec/core/idl.html#namespaces"><span class="std std-ref">namespaces</span></a>.
Note that this does not filter out traits based on namespaces.</p>
<div class="table-wrapper colwidths-given docutils container">
<table border="1" class="docutils align-default">
<table border="1" class="colwidths-given docutils align-default">
<colgroup>
<col width="10%" />
<col width="20%" />
Expand Down Expand Up @@ -883,7 +883,7 @@ <h1>smithy-build<a class="headerlink" href="#smithy-build" title="Permalink to t
<p>Filters out service shapes that are not included in the <code class="docutils literal notranslate"><span class="pre">services</span></code> list of
shape IDs.</p>
<div class="table-wrapper colwidths-given docutils container">
<table border="1" class="docutils align-default">
<table border="1" class="colwidths-given docutils align-default">
<colgroup>
<col width="10%" />
<col width="20%" />
Expand Down Expand Up @@ -929,7 +929,7 @@ <h1>smithy-build<a class="headerlink" href="#smithy-build" title="Permalink to t
<p>Removes tags from shapes and trait definitions that match any of the
provided <code class="docutils literal notranslate"><span class="pre">tags</span></code>.</p>
<div class="table-wrapper colwidths-given docutils container">
<table border="1" class="docutils align-default">
<table border="1" class="colwidths-given docutils align-default">
<colgroup>
<col width="10%" />
<col width="20%" />
Expand Down Expand Up @@ -978,7 +978,7 @@ <h1>smithy-build<a class="headerlink" href="#smithy-build" title="Permalink to t
automatically removed from the model. Use <code class="docutils literal notranslate"><span class="pre">removeUnusedShapes</span></code> to remove
orphaned shapes.</p>
<div class="table-wrapper colwidths-given docutils container">
<table border="1" class="docutils align-default">
<table border="1" class="colwidths-given docutils align-default">
<colgroup>
<col width="10%" />
<col width="20%" />
Expand Down Expand Up @@ -1052,7 +1052,7 @@ <h1>smithy-build<a class="headerlink" href="#smithy-build" title="Permalink to t
automatically removed from the model. Use <code class="docutils literal notranslate"><span class="pre">removeUnusedShapes</span></code> to remove
orphaned shapes.</p>
<div class="table-wrapper colwidths-given docutils container">
<table border="1" class="docutils align-default">
<table border="1" class="colwidths-given docutils align-default">
<colgroup>
<col width="10%" />
<col width="20%" />
Expand Down Expand Up @@ -1101,7 +1101,7 @@ <h1>smithy-build<a class="headerlink" href="#smithy-build" title="Permalink to t
<p>Removes and modifies suppressions found in <a class="reference internal" href="../../spec/core/model-validation.html#suppression-definition"><span class="std std-ref">metadata</span></a>
and the <a class="reference internal" href="../../spec/core/model-validation.html#suppress-trait"><span class="std std-ref">suppress trait</span></a>.</p>
<div class="table-wrapper colwidths-given docutils container">
<table border="1" class="docutils align-default">
<table border="1" class="colwidths-given docutils align-default">
<colgroup>
<col width="10%" />
<col width="20%" />
Expand Down Expand Up @@ -1304,7 +1304,7 @@ <h1>smithy-build<a class="headerlink" href="#smithy-build" title="Permalink to t
<p>Removes tags from shapes and trait definitions that are not in the <code class="docutils literal notranslate"><span class="pre">tags</span></code>
list.</p>
<div class="table-wrapper colwidths-given docutils container">
<table border="1" class="docutils align-default">
<table border="1" class="colwidths-given docutils align-default">
<colgroup>
<col width="10%" />
<col width="20%" />
Expand Down Expand Up @@ -1353,7 +1353,7 @@ <h1>smithy-build<a class="headerlink" href="#smithy-build" title="Permalink to t
automatically removed from the model. Use <code class="docutils literal notranslate"><span class="pre">removeUnusedShapes</span></code> to remove
orphaned shapes.</p>
<div class="table-wrapper colwidths-given docutils container">
<table border="1" class="docutils align-default">
<table border="1" class="colwidths-given docutils align-default">
<colgroup>
<col width="10%" />
<col width="20%" />
Expand Down Expand Up @@ -1427,7 +1427,7 @@ <h1>smithy-build<a class="headerlink" href="#smithy-build" title="Permalink to t
automatically removed from the model. Use <code class="docutils literal notranslate"><span class="pre">removeUnusedShapes</span></code> to remove
orphaned shapes.</p>
<div class="table-wrapper colwidths-given docutils container">
<table border="1" class="docutils align-default">
<table border="1" class="colwidths-given docutils align-default">
<colgroup>
<col width="10%" />
<col width="20%" />
Expand Down Expand Up @@ -1477,7 +1477,7 @@ <h1>smithy-build<a class="headerlink" href="#smithy-build" title="Permalink to t
<p>Removes model <a class="reference internal" href="../../spec/core/model.html#metadata"><span class="std std-ref">metadata</span></a> key-value pairs from a model if the
key is in the provided <code class="docutils literal notranslate"><span class="pre">keys</span></code> list.</p>
<div class="table-wrapper colwidths-given docutils container">
<table border="1" class="docutils align-default">
<table border="1" class="colwidths-given docutils align-default">
<colgroup>
<col width="10%" />
<col width="20%" />
Expand Down Expand Up @@ -1522,7 +1522,7 @@ <h1>smithy-build<a class="headerlink" href="#smithy-build" title="Permalink to t
<p>Removes model <a class="reference internal" href="../../spec/core/model.html#metadata"><span class="std std-ref">metadata</span></a> key-value pairs from a model if the
key is not in the provided <code class="docutils literal notranslate"><span class="pre">keys</span></code> list.</p>
<div class="table-wrapper colwidths-given docutils container">
<table border="1" class="docutils align-default">
<table border="1" class="colwidths-given docutils align-default">
<colgroup>
<col width="10%" />
<col width="20%" />
Expand Down Expand Up @@ -1567,7 +1567,7 @@ <h1>smithy-build<a class="headerlink" href="#smithy-build" title="Permalink to t
<p>Flattens namespaces of any shapes connected to a service into a target
namespace. Shapes not connected to a service will not be flattened.</p>
<div class="table-wrapper colwidths-given docutils container">
<table border="1" class="docutils align-default">
<table border="1" class="colwidths-given docutils align-default">
<colgroup>
<col width="10%" />
<col width="20%" />
Expand Down Expand Up @@ -1638,7 +1638,7 @@ <h1>smithy-build<a class="headerlink" href="#smithy-build" title="Permalink to t
<p>You can <em>export</em> trait definitions by applying specific tags to the trait
definition and adding the list of export tags in the <code class="docutils literal notranslate"><span class="pre">exportTagged</span></code> argument.</p>
<div class="table-wrapper colwidths-given docutils container">
<table border="1" class="docutils align-default">
<table border="1" class="colwidths-given docutils align-default">
<colgroup>
<col width="10%" />
<col width="20%" />
Expand Down Expand Up @@ -1692,7 +1692,7 @@ <h1>smithy-build<a class="headerlink" href="#smithy-build" title="Permalink to t
applying specific tags to the shape and adding the list of export tags in
the <code class="docutils literal notranslate"><span class="pre">exportTagged</span></code> argument.</p>
<div class="table-wrapper colwidths-given docutils container">
<table border="1" class="docutils align-default">
<table border="1" class="colwidths-given docutils align-default">
<colgroup>
<col width="10%" />
<col width="20%" />
Expand Down Expand Up @@ -1744,7 +1744,7 @@ <h1>smithy-build<a class="headerlink" href="#smithy-build" title="Permalink to t
<p>Renames shapes within the model, including updating any references to the
shapes that are being renamed.</p>
<div class="table-wrapper colwidths-given docutils container">
<table border="1" class="docutils align-default">
<table border="1" class="colwidths-given docutils align-default">
<colgroup>
<col width="10%" />
<col width="20%" />
Expand Down
14 changes: 7 additions & 7 deletions 1.0/guides/building-models/gradle-plugin.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,7 @@ <h1>Smithy Gradle Plugin<a class="headerlink" href="#smithy-gradle-plugin" title
</div></div>
<p>This extension supports the following properties:</p>
<div class="table-wrapper colwidths-given docutils container">
<table border="1" class="docutils align-default">
<table border="1" class="colwidths-given docutils align-default">
<colgroup>
<col width="10%" />
<col width="20%" />
Expand Down Expand Up @@ -436,12 +436,12 @@ <h1>Smithy Gradle Plugin<a class="headerlink" href="#smithy-gradle-plugin" title
<span class="p">}</span>

<span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-model:1.45.0&quot;</span><span class="p">)</span>
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-model:1.46.0&quot;</span><span class="p">)</span>

<span class="w"> </span><span class="c1">// These are just examples of dependencies. This model has a dependency on</span>
<span class="w"> </span><span class="c1">// a &quot;common&quot; model package and uses the external AWS traits.</span>
<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>
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-traits:1.45.0&quot;</span><span class="p">)</span>
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-traits:1.46.0&quot;</span><span class="p">)</span>
<span class="p">}</span>
</pre></div>
</div>
Expand Down Expand Up @@ -471,7 +471,7 @@ <h1>Smithy Gradle Plugin<a class="headerlink" href="#smithy-gradle-plugin" title
<span class="w"> </span><span class="n">mavenCentral</span><span class="p">()</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-traits:1.45.0&quot;</span><span class="p">)</span>
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-traits:1.46.0&quot;</span><span class="p">)</span>

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

<span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-model:1.45.0&quot;</span><span class="p">)</span>
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-model:1.46.0&quot;</span><span class="p">)</span>

<span class="w"> </span><span class="c1">// Any dependencies that the projected model needs must be (re)declared</span>
<span class="w"> </span><span class="c1">// here. For example, let&#39;s assume that the smithy-aws-traits package is</span>
<span class="w"> </span><span class="c1">// needed in the projected model too.</span>
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-traits:1.45.0&quot;</span><span class="p">)</span>
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-aws-traits:1.46.0&quot;</span><span class="p">)</span>
<span class="p">}</span>
</pre></div>
</div>
Expand Down Expand Up @@ -600,7 +600,7 @@ <h1>Smithy Gradle Plugin<a class="headerlink" href="#smithy-gradle-plugin" title

<span class="w"> </span><span class="c1">// This dependency is required in order to apply the &quot;openapi&quot;</span>
<span class="w"> </span><span class="c1">// plugin in smithy-build.json</span>
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-openapi:1.45.0&quot;</span><span class="p">)</span>
<span class="w"> </span><span class="n">classpath</span><span class="p">(</span><span class="s">&quot;software.amazon.smithy:smithy-openapi:1.46.0&quot;</span><span class="p">)</span>
<span class="w"> </span><span class="p">}</span>
<span class="p">}</span>
</pre></div>
Expand Down
Loading

0 comments on commit 48e3837

Please sign in to comment.