Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
smithy-automation committed Mar 28, 2024
1 parent 48e3837 commit 8c98e0f
Show file tree
Hide file tree
Showing 1,718 changed files with 672,248 additions and 1,099 deletions.
13 changes: 8 additions & 5 deletions 1.0/_sources/spec/http-protocol-compliance-tests.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -207,8 +207,10 @@ that support the following members:
to parse and validate the expected data against generated data.
* - params
- ``document``
- Defines the input parameters used to generate the HTTP request. These
parameters MUST be compatible with the input of the operation.
- For clients, defines the input parameters used to generate the HTTP
request. For servers, defines the input parameters extracted from the
HTTP request. These parameters MUST be compatible with the input of the
operation.

Parameter values that contain binary data MUST be defined using
values that can be represented in plain text (for example, use "foo"
Expand Down Expand Up @@ -391,9 +393,10 @@ structures that support the following members:
base64 encoded.
* - params
- ``document``
- Defines the output or error parameters used to generate the HTTP
response. These parameters MUST be compatible with the targeted
operation's output or the targeted error structure.
- For clients, defines the output or error parameters extracted from the
HTTP response. For servers, defines the output or error parameters used
to generate the HTTP response. These parameters MUST be compatible with
the targeted operation's output or the targeted error structure.

Parameter values that contain binary data MUST be defined using
values that can be represented in plain text (for example, use "foo"
Expand Down
47 changes: 24 additions & 23 deletions 1.0/_static/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -236,16 +236,6 @@ 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 @@ -334,11 +324,15 @@ 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 @@ -377,13 +371,17 @@ 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 @@ -608,19 +606,26 @@ ol.simple p,
ul.simple p {
margin-bottom: 0;
}
dl.footnote > dt,
dl.citation > dt {
aside.footnote > span,
div.citation > span {
float: left;
margin-right: 0.5em;
}

dl.footnote > dd,
dl.citation > dd {
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 {
margin-bottom: 0em;
}

dl.footnote > dd:after,
dl.citation > dd:after {
aside.footnote > p:last-of-type:after,
div.citation > p:last-of-type:after {
content: "";
clear: both;
}
Expand All @@ -636,10 +641,6 @@ 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
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="colwidths-given docutils align-default">
<table border="1" class="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="colwidths-given docutils align-default">
<table border="1" class="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="colwidths-given docutils align-default">
<table border="1" class="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="colwidths-given docutils align-default">
<table border="1" class="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="colwidths-given docutils align-default">
<table border="1" class="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="colwidths-given docutils align-default">
<table border="1" class="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="colwidths-given docutils align-default">
<table border="1" class="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="colwidths-given docutils align-default">
<table border="1" class="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="colwidths-given docutils align-default">
<table border="1" class="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="colwidths-given docutils align-default">
<table border="1" class="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="colwidths-given docutils align-default">
<table border="1" class="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="colwidths-given docutils align-default">
<table border="1" class="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="colwidths-given docutils align-default">
<table border="1" class="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="colwidths-given docutils align-default">
<table border="1" class="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="colwidths-given docutils align-default">
<table border="1" class="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="colwidths-given docutils align-default">
<table border="1" class="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="colwidths-given docutils align-default">
<table border="1" class="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="colwidths-given docutils align-default">
<table border="1" class="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="colwidths-given docutils align-default">
<table border="1" class="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="colwidths-given docutils align-default">
<table border="1" class="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="colwidths-given docutils align-default">
<table border="1" class="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="colwidths-given docutils align-default">
<table border="1" class="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="colwidths-given docutils align-default">
<table border="1" class="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="colwidths-given docutils align-default">
<table border="1" class="docutils align-default">
<colgroup>
<col width="10%" />
<col width="20%" />
Expand Down
Loading

0 comments on commit 8c98e0f

Please sign in to comment.