Skip to content

Update ReSpec-rendered specification versions #4112

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Update ReSpec-rendered specification versions #4112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions oas/latest.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@
"publishISODate": "2021-02-15T00:00:00.000Z",
"generatedSubtitle": "15 February 2021"
}</script>
<link rel="stylesheet" href="https://www.w3.org/StyleSheets/TR/2021/base.css"></head><body class="h-entry toc-inline"><div class="head">
<link rel="stylesheet" href="https://www.w3.org/StyleSheets/TR/2021/base.css"></head><body class="h-entry"><div class="head">
<p class="logos"><a class="logo" href="https://openapis.org/"><img crossorigin="" alt="OpenAPI Initiative" height="48" src="https://raw.githubusercontent.com/OAI/OpenAPI-Style-Guide/master/graphics/bitmap/OpenAPI_Logo_Pantone.png">
</a></p>
<h1 id="title" class="title">OpenAPI Specification v3.1.0 </h1> <h2 id="subtitle" class="subtitle">Version 3.1.0</h2>
Expand Down Expand Up @@ -1585,7 +1585,7 @@ <h1 id="title" class="title">OpenAPI Specification v3.1.0 </h1> <h2 id="subtitle
<p>Assume a parameter named <code>color</code> has one of the following values:</p>
<pre class="highlight " tabindex="0"><code aria-busy="false" class="hljs css"> string -&gt; "blue"
array -&gt; <span class="hljs-selector-attr">[<span class="hljs-string">"blue"</span>,<span class="hljs-string">"black"</span>,<span class="hljs-string">"brown"</span>]</span>
<span class="hljs-selector-tag">object</span> -&gt; { "R": <span class="hljs-number">100</span>, <span class="hljs-string">"G"</span>: <span class="hljs-number">200</span>, <span class="hljs-string">"B"</span>: <span class="hljs-number">150</span> }
<span class="hljs-selector-tag">object</span> -&gt; { "<span class="hljs-attribute">R</span>": <span class="hljs-number">100</span>, <span class="hljs-string">"G"</span>: <span class="hljs-number">200</span>, <span class="hljs-string">"B"</span>: <span class="hljs-number">150</span> }
</code></pre>
<p>The following table shows examples of rendering differences for each value.</p>
<table>
Expand Down
2 changes: 1 addition & 1 deletion oas/v2.0.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@
"publishISODate": "2014-09-08T00:00:00.000Z",
"generatedSubtitle": "08 September 2014"
}</script>
<link rel="stylesheet" href="https://www.w3.org/StyleSheets/TR/2021/base.css"></head><body class="h-entry toc-inline"><div class="head">
<link rel="stylesheet" href="https://www.w3.org/StyleSheets/TR/2021/base.css"></head><body class="h-entry"><div class="head">
<p class="logos"><a class="logo" href="https://openapis.org/"><img crossorigin="" alt="OpenAPI Initiative" height="48" src="https://raw.githubusercontent.com/OAI/OpenAPI-Style-Guide/master/graphics/bitmap/OpenAPI_Logo_Pantone.png">
</a></p>
<h1 id="title" class="title">OpenAPI Specification v2.0 </h1> <h2 id="subtitle" class="subtitle">Version 2.0</h2>
Expand Down
34 changes: 17 additions & 17 deletions oas/v3.0.0.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@
"publishISODate": "2017-07-26T00:00:00.000Z",
"generatedSubtitle": "26 July 2017"
}</script>
<link rel="stylesheet" href="https://www.w3.org/StyleSheets/TR/2021/base.css"></head><body class="h-entry toc-inline"><div class="head">
<link rel="stylesheet" href="https://www.w3.org/StyleSheets/TR/2021/base.css"></head><body class="h-entry"><div class="head">
<p class="logos"><a class="logo" href="https://openapis.org/"><img crossorigin="" alt="OpenAPI Initiative" height="48" src="https://raw.githubusercontent.com/OAI/OpenAPI-Style-Guide/master/graphics/bitmap/OpenAPI_Logo_Pantone.png">
</a></p>
<h1 id="title" class="title">OpenAPI Specification v3.0.0 </h1> <h2 id="subtitle" class="subtitle">Version 3.0.0</h2>
Expand Down Expand Up @@ -1562,7 +1562,7 @@ <h1 id="title" class="title">OpenAPI Specification v3.0.0 </h1> <h2 id="subtitle
<p>Assume a parameter named <code>color</code> has one of the following values:</p>
<pre class="highlight " tabindex="0"><code aria-busy="false" class="hljs css"> string -&gt; "blue"
array -&gt; <span class="hljs-selector-attr">[<span class="hljs-string">"blue"</span>,<span class="hljs-string">"black"</span>,<span class="hljs-string">"brown"</span>]</span>
<span class="hljs-selector-tag">object</span> -&gt; { "R": <span class="hljs-number">100</span>, <span class="hljs-string">"G"</span>: <span class="hljs-number">200</span>, <span class="hljs-string">"B"</span>: <span class="hljs-number">150</span> }
<span class="hljs-selector-tag">object</span> -&gt; { "<span class="hljs-attribute">R</span>": <span class="hljs-number">100</span>, <span class="hljs-string">"G"</span>: <span class="hljs-number">200</span>, <span class="hljs-string">"B"</span>: <span class="hljs-number">150</span> }
</code></pre>
<p>The following table shows examples of rendering differences for each value.</p>
<table>
Expand Down Expand Up @@ -2765,10 +2765,10 @@ <h1 id="title" class="title">OpenAPI Specification v3.0.0 </h1> <h2 id="subtitle
query-reference = <span class="hljs-string">"query."</span> name
path-reference = <span class="hljs-string">"path."</span> name
body-reference = <span class="hljs-string">"body"</span> [<span class="hljs-string">"#"</span> fragment]
fragment = a <span class="hljs-built_in">JSON</span> Pointer [RFC <span class="hljs-number">6901</span>](https:<span class="hljs-comment">//tools.ietf.org/html/rfc6901) </span>
fragment = a <span class="hljs-title class_">JSON</span> <span class="hljs-title class_">Pointer</span> [<span class="hljs-variable constant_">RFC</span> <span class="hljs-number">6901</span>](<span class="hljs-attr">https</span>:<span class="hljs-comment">//tools.ietf.org/html/rfc6901) </span>
name = *( char )
char = <span class="hljs-keyword">as</span> per RFC [<span class="hljs-number">7159</span>](https:<span class="hljs-comment">//tools.ietf.org/html/rfc7159#section-7)</span>
token = <span class="hljs-keyword">as</span> per RFC [<span class="hljs-number">7230</span>](https:<span class="hljs-comment">//tools.ietf.org/html/rfc7230#section-3.2.6)</span>
char = <span class="hljs-keyword">as</span> per <span class="hljs-variable constant_">RFC</span> [<span class="hljs-number">7159</span>](<span class="hljs-attr">https</span>:<span class="hljs-comment">//tools.ietf.org/html/rfc7159#section-7)</span>
token = <span class="hljs-keyword">as</span> per <span class="hljs-variable constant_">RFC</span> [<span class="hljs-number">7230</span>](<span class="hljs-attr">https</span>:<span class="hljs-comment">//tools.ietf.org/html/rfc7230#section-3.2.6)</span>
</code></pre>
<p>The <code>name</code> identifier is case-sensitive, whereas <code>token</code> is not.</p>
<p>The table below provides examples of runtime expressions and examples of their use in a value:</p>
Expand Down Expand Up @@ -3428,10 +3428,10 @@ <h1 id="title" class="title">OpenAPI Specification v3.0.0 </h1> <h2 id="subtitle
propertyName: pet_type
</code></pre>
<p>The expectation now is that a property with name <code>pet_type</code> <em><em class="rfc2119">MUST</em></em> be present in the response payload, and the value will correspond to the name of a schema defined in the OAS document. Thus the response payload:</p>
<pre class="highlight " tabindex="0"><code aria-busy="false" class="hljs json">{
<span class="hljs-attr">"id"</span>: <span class="hljs-number">12345</span>,
<span class="hljs-attr">"pet_type"</span>: <span class="hljs-string">"Cat"</span>
}
<pre class="highlight " tabindex="0"><code aria-busy="false" class="hljs json"><span class="hljs-punctuation">{</span>
<span class="hljs-attr">"id"</span><span class="hljs-punctuation">:</span> <span class="hljs-number">12345</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"pet_type"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"Cat"</span>
<span class="hljs-punctuation">}</span>
</code></pre>
<p>Will indicate that the <code>Cat</code> schema be used in conjunction with this payload.</p>
<p>In scenarios where the value of the discriminator field does not match the schema name or implicit mapping is not possible, an optional <code>mapping</code> definition <em class="rfc2119">MAY</em> be used:</p>
Expand Down Expand Up @@ -3490,16 +3490,16 @@ <h1 id="title" class="title">OpenAPI Specification v3.0.0 </h1> <h2 id="subtitle
type: boolean
</code></pre>
<p>a payload like this:</p>
<pre class="highlight " tabindex="0"><code aria-busy="false" class="hljs json">{
<span class="hljs-attr">"pet_type"</span>: <span class="hljs-string">"Cat"</span>,
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"misty"</span>
}
<pre class="highlight " tabindex="0"><code aria-busy="false" class="hljs json"><span class="hljs-punctuation">{</span>
<span class="hljs-attr">"pet_type"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"Cat"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"name"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"misty"</span>
<span class="hljs-punctuation">}</span>
</code></pre>
<p>will indicate that the <code>Cat</code> schema be used. Likewise this schema:</p>
<pre class="highlight " tabindex="0"><code aria-busy="false" class="hljs json">{
<span class="hljs-attr">"pet_type"</span>: <span class="hljs-string">"cachorro"</span>,
<span class="hljs-attr">"bark"</span>: <span class="hljs-string">"soft"</span>
}
<pre class="highlight " tabindex="0"><code aria-busy="false" class="hljs json"><span class="hljs-punctuation">{</span>
<span class="hljs-attr">"pet_type"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"cachorro"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"bark"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"soft"</span>
<span class="hljs-punctuation">}</span>
</code></pre>
<p>will map to <code>Dog</code> because of the definition in the <code>mappings</code> element.</p>
</section></section><section id="xml-object"><div class="header-wrapper"><h4 id="x4-7-27-xml-object"><bdi class="secno">4.7.27 </bdi>XML Object</h4><a class="self-link" href="#xml-object" aria-label="Permalink for Section 4.7.27"></a></div>
Expand Down
34 changes: 17 additions & 17 deletions oas/v3.0.1.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@
"publishISODate": "2017-12-06T00:00:00.000Z",
"generatedSubtitle": "06 December 2017"
}</script>
<link rel="stylesheet" href="https://www.w3.org/StyleSheets/TR/2021/base.css"></head><body class="h-entry toc-inline"><div class="head">
<link rel="stylesheet" href="https://www.w3.org/StyleSheets/TR/2021/base.css"></head><body class="h-entry"><div class="head">
<p class="logos"><a class="logo" href="https://openapis.org/"><img crossorigin="" alt="OpenAPI Initiative" height="48" src="https://raw.githubusercontent.com/OAI/OpenAPI-Style-Guide/master/graphics/bitmap/OpenAPI_Logo_Pantone.png">
</a></p>
<h1 id="title" class="title">OpenAPI Specification v3.0.1 </h1> <h2 id="subtitle" class="subtitle">Version 3.0.1</h2>
Expand Down Expand Up @@ -1567,7 +1567,7 @@ <h1 id="title" class="title">OpenAPI Specification v3.0.1 </h1> <h2 id="subtitle
<p>Assume a parameter named <code>color</code> has one of the following values:</p>
<pre class="highlight " tabindex="0"><code aria-busy="false" class="hljs css"> string -&gt; "blue"
array -&gt; <span class="hljs-selector-attr">[<span class="hljs-string">"blue"</span>,<span class="hljs-string">"black"</span>,<span class="hljs-string">"brown"</span>]</span>
<span class="hljs-selector-tag">object</span> -&gt; { "R": <span class="hljs-number">100</span>, <span class="hljs-string">"G"</span>: <span class="hljs-number">200</span>, <span class="hljs-string">"B"</span>: <span class="hljs-number">150</span> }
<span class="hljs-selector-tag">object</span> -&gt; { "<span class="hljs-attribute">R</span>": <span class="hljs-number">100</span>, <span class="hljs-string">"G"</span>: <span class="hljs-number">200</span>, <span class="hljs-string">"B"</span>: <span class="hljs-number">150</span> }
</code></pre>
<p>The following table shows examples of rendering differences for each value.</p>
<table>
Expand Down Expand Up @@ -2770,10 +2770,10 @@ <h1 id="title" class="title">OpenAPI Specification v3.0.1 </h1> <h2 id="subtitle
query-reference = <span class="hljs-string">"query."</span> name
path-reference = <span class="hljs-string">"path."</span> name
body-reference = <span class="hljs-string">"body"</span> [<span class="hljs-string">"#"</span> fragment]
fragment = a <span class="hljs-built_in">JSON</span> Pointer [RFC <span class="hljs-number">6901</span>](https:<span class="hljs-comment">//tools.ietf.org/html/rfc6901) </span>
fragment = a <span class="hljs-title class_">JSON</span> <span class="hljs-title class_">Pointer</span> [<span class="hljs-variable constant_">RFC</span> <span class="hljs-number">6901</span>](<span class="hljs-attr">https</span>:<span class="hljs-comment">//tools.ietf.org/html/rfc6901) </span>
name = *( char )
char = <span class="hljs-keyword">as</span> per RFC [<span class="hljs-number">7159</span>](https:<span class="hljs-comment">//tools.ietf.org/html/rfc7159#section-7)</span>
token = <span class="hljs-keyword">as</span> per RFC [<span class="hljs-number">7230</span>](https:<span class="hljs-comment">//tools.ietf.org/html/rfc7230#section-3.2.6)</span>
char = <span class="hljs-keyword">as</span> per <span class="hljs-variable constant_">RFC</span> [<span class="hljs-number">7159</span>](<span class="hljs-attr">https</span>:<span class="hljs-comment">//tools.ietf.org/html/rfc7159#section-7)</span>
token = <span class="hljs-keyword">as</span> per <span class="hljs-variable constant_">RFC</span> [<span class="hljs-number">7230</span>](<span class="hljs-attr">https</span>:<span class="hljs-comment">//tools.ietf.org/html/rfc7230#section-3.2.6)</span>
</code></pre>
<p>The <code>name</code> identifier is case-sensitive, whereas <code>token</code> is not.</p>
<p>The table below provides examples of runtime expressions and examples of their use in a value:</p>
Expand Down Expand Up @@ -3375,10 +3375,10 @@ <h1 id="title" class="title">OpenAPI Specification v3.0.1 </h1> <h2 id="subtitle
propertyName: pet_type
</code></pre>
<p>The expectation now is that a property with name <code>pet_type</code> <em><em class="rfc2119">MUST</em></em> be present in the response payload, and the value will correspond to the name of a schema defined in the OAS document. Thus the response payload:</p>
<pre class="highlight " tabindex="0"><code aria-busy="false" class="hljs json">{
<span class="hljs-attr">"id"</span>: <span class="hljs-number">12345</span>,
<span class="hljs-attr">"pet_type"</span>: <span class="hljs-string">"Cat"</span>
}
<pre class="highlight " tabindex="0"><code aria-busy="false" class="hljs json"><span class="hljs-punctuation">{</span>
<span class="hljs-attr">"id"</span><span class="hljs-punctuation">:</span> <span class="hljs-number">12345</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"pet_type"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"Cat"</span>
<span class="hljs-punctuation">}</span>
</code></pre>
<p>Will indicate that the <code>Cat</code> schema be used in conjunction with this payload.</p>
<p>In scenarios where the value of the discriminator field does not match the schema name or implicit mapping is not possible, an optional <code>mapping</code> definition <em class="rfc2119">MAY</em> be used:</p>
Expand Down Expand Up @@ -3437,16 +3437,16 @@ <h1 id="title" class="title">OpenAPI Specification v3.0.1 </h1> <h2 id="subtitle
type: boolean
</code></pre>
<p>a payload like this:</p>
<pre class="highlight " tabindex="0"><code aria-busy="false" class="hljs json">{
<span class="hljs-attr">"pet_type"</span>: <span class="hljs-string">"Cat"</span>,
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"misty"</span>
}
<pre class="highlight " tabindex="0"><code aria-busy="false" class="hljs json"><span class="hljs-punctuation">{</span>
<span class="hljs-attr">"pet_type"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"Cat"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"name"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"misty"</span>
<span class="hljs-punctuation">}</span>
</code></pre>
<p>will indicate that the <code>Cat</code> schema be used. Likewise this schema:</p>
<pre class="highlight " tabindex="0"><code aria-busy="false" class="hljs json">{
<span class="hljs-attr">"pet_type"</span>: <span class="hljs-string">"cachorro"</span>,
<span class="hljs-attr">"bark"</span>: <span class="hljs-string">"soft"</span>
}
<pre class="highlight " tabindex="0"><code aria-busy="false" class="hljs json"><span class="hljs-punctuation">{</span>
<span class="hljs-attr">"pet_type"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"cachorro"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"bark"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"soft"</span>
<span class="hljs-punctuation">}</span>
</code></pre>
<p>will map to <code>Dog</code> because of the definition in the <code>mappings</code> element.</p>
</section></section><section id="xml-object"><div class="header-wrapper"><h4 id="x4-7-26-xml-object"><bdi class="secno">4.7.26 </bdi>XML Object</h4><a class="self-link" href="#xml-object" aria-label="Permalink for Section 4.7.26"></a></div>
Expand Down
Loading