Skip to content
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.

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

Update ReSpec-rendered specification versions #4046

Merged
merged 1 commit into from
Aug 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 2 additions & 3 deletions oas/latest.html
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,6 @@ <h1 id="title" class="title">OpenAPI Specification v3.1.0 </h1> <h2 id="subtitle
</section></section><section id="introduction"><div class="header-wrapper"><h2 id="x2-introduction"><bdi class="secno">2. </bdi>Introduction</h2><a class="self-link" href="#introduction" aria-label="Permalink for Section 2."></a></div>
<p>The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to HTTP APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined, a consumer can understand and interact with the remote service with a minimal amount of implementation logic.</p>
<p>An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases.</p>

</section><section id="definitions"><div class="header-wrapper"><h2 id="x3-definitions"><bdi class="secno">3. </bdi><dfn id="dfn-definitions" tabindex="0" aria-haspopup="dialog" data-dfn-type="dfn">Definitions</dfn></h2><a class="self-link" href="#definitions" aria-label="Permalink for Section 3."></a></div>
<section id="openapi-document"><div class="header-wrapper"><h3 id="x3-1-openapi-document"><bdi class="secno">3.1 </bdi><dfn id="dfn-openapi-document" tabindex="0" aria-haspopup="dialog" data-dfn-type="dfn">OpenAPI Document</dfn></h3><a class="self-link" href="#openapi-document" aria-label="Permalink for Section 3.1"></a></div>
<p>A self-contained or composite resource which defines or describes an API or elements of an API. The OpenAPI document <em class="rfc2119">MUST</em> contain at least one <a href="#paths-object">paths</a> field, a <a href="#oasComponents">components</a> field or a <a href="#oasWebhooks">webhooks</a> field. An OpenAPI document uses and conforms to the OpenAPI Specification.</p>
Expand Down Expand Up @@ -396,7 +395,7 @@ <h1 id="title" class="title">OpenAPI Specification v3.1.0 </h1> <h2 id="subtitle
<tr>
<td><span id="oasWebhooks"></span>webhooks</td>
<td style="text-align:center">Map[<code>string</code>, <a href="#path-item-object">Path Item Object</a> | <a href="#reference-object">Reference Object</a>] ]</td>
<td>The incoming webhooks that <em class="rfc2119">MAY</em> be received as part of this API and that the API consumer <em class="rfc2119">MAY</em> choose to implement. Closely related to the <code>callbacks</code> feature, this section describes requests initiated other than by an API call, for example by an out of band registration. The key name is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the expected responses. An <a href="https://learn.openapis.org/examples/v3.1/webhook-example.yaml">example</a> is available.</td>
<td>The incoming webhooks that <em class="rfc2119">MAY</em> be received as part of this API and that the API consumer <em class="rfc2119">MAY</em> choose to implement. Closely related to the <code>callbacks</code> feature, this section describes requests initiated other than by an API call, for example by an out of band registration. The key name is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the expected responses. An <a href="https://learn.openapis.org/examples/v3.1/webhook-example.html">example</a> is available.</td>
</tr>
<tr>
<td><span id="oasComponents"></span>components</td>
Expand Down Expand Up @@ -2471,7 +2470,7 @@ <h1 id="title" class="title">OpenAPI Specification v3.1.0 </h1> <h2 id="subtitle
<tr>
<td><span id="callbackExpression"></span>{expression}</td>
<td style="text-align:center"><a href="#path-item-object">Path Item Object</a> | <a href="#reference-object">Reference Object</a></td>
<td>A Path Item Object, or a reference to one, used to define a callback request and expected responses. A <a href="https://learn.openapis.org/examples/v3.0/callback-example.yaml">complete example</a> is available.</td>
<td>A Path Item Object, or a reference to one, used to define a callback request and expected responses. A <a href="https://learn.openapis.org/examples/v3.0/callback-example.html">complete example</a> is available.</td>
</tr>
</tbody>
</table>
Expand Down
3 changes: 1 addition & 2 deletions oas/v3.0.0.html
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,6 @@ <h1 id="title" class="title">OpenAPI Specification v3.0.0 </h1> <h2 id="subtitle
</section></section><section id="introduction"><div class="header-wrapper"><h2 id="x2-introduction"><bdi class="secno">2. </bdi>Introduction</h2><a class="self-link" href="#introduction" aria-label="Permalink for Section 2."></a></div>
<p>The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined, a consumer can understand and interact with the remote service with a minimal amount of implementation logic.</p>
<p>An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases.</p>

</section><section id="definitions"><div class="header-wrapper"><h2 id="x3-definitions"><bdi class="secno">3. </bdi><dfn id="dfn-definitions" tabindex="0" aria-haspopup="dialog" data-dfn-type="dfn">Definitions</dfn></h2><a class="self-link" href="#definitions" aria-label="Permalink for Section 3."></a></div>
<section id="openapi-document"><div class="header-wrapper"><h3 id="x3-1-openapi-document"><bdi class="secno">3.1 </bdi><dfn id="dfn-openapi-document" tabindex="0" aria-haspopup="dialog" data-dfn-type="dfn">OpenAPI Document</dfn></h3><a class="self-link" href="#openapi-document" aria-label="Permalink for Section 3.1"></a></div>
<p>A document (or set of documents) that defines or describes an API. An OpenAPI definition uses and conforms to the OpenAPI Specification.</p>
Expand Down Expand Up @@ -2445,7 +2444,7 @@ <h1 id="title" class="title">OpenAPI Specification v3.0.0 </h1> <h2 id="subtitle
<tr>
<td><span id="callbackExpression"></span>{expression}</td>
<td style="text-align:center"><a href="#path-item-object">Path Item Object</a></td>
<td>A Path Item Object used to define a callback request and expected responses. A <a href="https://learn.openapis.org/examples/v3.0/callback-example.yaml">complete example</a> is available.</td>
<td>A Path Item Object used to define a callback request and expected responses. A <a href="https://learn.openapis.org/examples/v3.0/callback-example.html">complete example</a> is available.</td>
</tr>
</tbody>
</table>
Expand Down
5 changes: 2 additions & 3 deletions oas/v3.0.1.html
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"><div class="head">
<link rel="stylesheet" href="https://www.w3.org/StyleSheets/TR/2021/base.css"></head><body class="h-entry toc-inline"><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 @@ -239,7 +239,6 @@ <h1 id="title" class="title">OpenAPI Specification v3.0.1 </h1> <h2 id="subtitle
</section></section><section id="introduction"><div class="header-wrapper"><h2 id="x2-introduction"><bdi class="secno">2. </bdi>Introduction</h2><a class="self-link" href="#introduction" aria-label="Permalink for Section 2."></a></div>
<p>The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined, a consumer can understand and interact with the remote service with a minimal amount of implementation logic.</p>
<p>An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases.</p>

</section><section id="definitions"><div class="header-wrapper"><h2 id="x3-definitions"><bdi class="secno">3. </bdi><dfn id="dfn-definitions" tabindex="0" aria-haspopup="dialog" data-dfn-type="dfn">Definitions</dfn></h2><a class="self-link" href="#definitions" aria-label="Permalink for Section 3."></a></div>
<section id="openapi-document"><div class="header-wrapper"><h3 id="x3-1-openapi-document"><bdi class="secno">3.1 </bdi><dfn id="dfn-openapi-document" tabindex="0" aria-haspopup="dialog" data-dfn-type="dfn">OpenAPI Document</dfn></h3><a class="self-link" href="#openapi-document" aria-label="Permalink for Section 3.1"></a></div>
<p>A document (or set of documents) that defines or describes an API. An OpenAPI definition uses and conforms to the OpenAPI Specification.</p>
Expand Down Expand Up @@ -2450,7 +2449,7 @@ <h1 id="title" class="title">OpenAPI Specification v3.0.1 </h1> <h2 id="subtitle
<tr>
<td><span id="callbackExpression"></span>{expression}</td>
<td style="text-align:center"><a href="#path-item-object">Path Item Object</a></td>
<td>A Path Item Object used to define a callback request and expected responses. A <a href="https://learn.openapis.org/examples/v3.0/callback-example.yaml">complete example</a> is available.</td>
<td>A Path Item Object used to define a callback request and expected responses. A <a href="https://learn.openapis.org/examples/v3.0/callback-example.html">complete example</a> is available.</td>
</tr>
</tbody>
</table>
Expand Down
5 changes: 2 additions & 3 deletions oas/v3.0.2.html
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@
"publishISODate": "2018-10-08T00:00:00.000Z",
"generatedSubtitle": "08 October 2018"
}</script>
<link rel="stylesheet" href="https://www.w3.org/StyleSheets/TR/2021/base.css"></head><body class="h-entry"><div class="head">
<link rel="stylesheet" href="https://www.w3.org/StyleSheets/TR/2021/base.css"></head><body class="h-entry toc-inline"><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.2 </h1> <h2 id="subtitle" class="subtitle">Version 3.0.2</h2>
Expand Down Expand Up @@ -249,7 +249,6 @@ <h1 id="title" class="title">OpenAPI Specification v3.0.2 </h1> <h2 id="subtitle
</section></section><section id="introduction"><div class="header-wrapper"><h2 id="x2-introduction"><bdi class="secno">2. </bdi>Introduction</h2><a class="self-link" href="#introduction" aria-label="Permalink for Section 2."></a></div>
<p>The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined, a consumer can understand and interact with the remote service with a minimal amount of implementation logic.</p>
<p>An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases.</p>

</section><section id="definitions"><div class="header-wrapper"><h2 id="x3-definitions"><bdi class="secno">3. </bdi><dfn id="dfn-definitions" tabindex="0" aria-haspopup="dialog" data-dfn-type="dfn">Definitions</dfn></h2><a class="self-link" href="#definitions" aria-label="Permalink for Section 3."></a></div>
<section id="openapi-document"><div class="header-wrapper"><h3 id="x3-1-openapi-document"><bdi class="secno">3.1 </bdi><dfn id="dfn-openapi-document" tabindex="0" aria-haspopup="dialog" data-dfn-type="dfn">OpenAPI Document</dfn></h3><a class="self-link" href="#openapi-document" aria-label="Permalink for Section 3.1"></a></div>
<p>A document (or set of documents) that defines or describes an API. An OpenAPI definition uses and conforms to the OpenAPI Specification.</p>
Expand Down Expand Up @@ -2469,7 +2468,7 @@ <h1 id="title" class="title">OpenAPI Specification v3.0.2 </h1> <h2 id="subtitle
<tr>
<td><span id="callbackExpression"></span>{expression}</td>
<td style="text-align:center"><a href="#path-item-object">Path Item Object</a></td>
<td>A Path Item Object used to define a callback request and expected responses. A <a href="https://learn.openapis.org/examples/v3.0/callback-example.yaml">complete example</a> is available.</td>
<td>A Path Item Object used to define a callback request and expected responses. A <a href="https://learn.openapis.org/examples/v3.0/callback-example.html">complete example</a> is available.</td>
</tr>
</tbody>
</table>
Expand Down
3 changes: 1 addition & 2 deletions oas/v3.0.3.html
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,6 @@ <h1 id="title" class="title">OpenAPI Specification v3.0.3 </h1> <h2 id="subtitle
</section></section><section id="introduction"><div class="header-wrapper"><h2 id="x2-introduction"><bdi class="secno">2. </bdi>Introduction</h2><a class="self-link" href="#introduction" aria-label="Permalink for Section 2."></a></div>
<p>The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined, a consumer can understand and interact with the remote service with a minimal amount of implementation logic.</p>
<p>An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases.</p>

</section><section id="definitions"><div class="header-wrapper"><h2 id="x3-definitions"><bdi class="secno">3. </bdi><dfn id="dfn-definitions" tabindex="0" aria-haspopup="dialog" data-dfn-type="dfn">Definitions</dfn></h2><a class="self-link" href="#definitions" aria-label="Permalink for Section 3."></a></div>
<section id="openapi-document"><div class="header-wrapper"><h3 id="x3-1-openapi-document"><bdi class="secno">3.1 </bdi><dfn id="dfn-openapi-document" tabindex="0" aria-haspopup="dialog" data-dfn-type="dfn">OpenAPI Document</dfn></h3><a class="self-link" href="#openapi-document" aria-label="Permalink for Section 3.1"></a></div>
<p>A document (or set of documents) that defines or describes an API. An OpenAPI definition uses and conforms to the OpenAPI Specification.</p>
Expand Down Expand Up @@ -2471,7 +2470,7 @@ <h1 id="title" class="title">OpenAPI Specification v3.0.3 </h1> <h2 id="subtitle
<tr>
<td><span id="callbackExpression"></span>{expression}</td>
<td style="text-align:center"><a href="#path-item-object">Path Item Object</a></td>
<td>A Path Item Object used to define a callback request and expected responses. A <a href="https://learn.openapis.org/examples/v3.0/callback-example.yaml">complete example</a> is available.</td>
<td>A Path Item Object used to define a callback request and expected responses. A <a href="https://learn.openapis.org/examples/v3.0/callback-example.html">complete example</a> is available.</td>
</tr>
</tbody>
</table>
Expand Down
5 changes: 2 additions & 3 deletions oas/v3.1.0.html
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,6 @@ <h1 id="title" class="title">OpenAPI Specification v3.1.0 </h1> <h2 id="subtitle
</section></section><section id="introduction"><div class="header-wrapper"><h2 id="x2-introduction"><bdi class="secno">2. </bdi>Introduction</h2><a class="self-link" href="#introduction" aria-label="Permalink for Section 2."></a></div>
<p>The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to HTTP APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined, a consumer can understand and interact with the remote service with a minimal amount of implementation logic.</p>
<p>An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases.</p>

</section><section id="definitions"><div class="header-wrapper"><h2 id="x3-definitions"><bdi class="secno">3. </bdi><dfn id="dfn-definitions" tabindex="0" aria-haspopup="dialog" data-dfn-type="dfn">Definitions</dfn></h2><a class="self-link" href="#definitions" aria-label="Permalink for Section 3."></a></div>
<section id="openapi-document"><div class="header-wrapper"><h3 id="x3-1-openapi-document"><bdi class="secno">3.1 </bdi><dfn id="dfn-openapi-document" tabindex="0" aria-haspopup="dialog" data-dfn-type="dfn">OpenAPI Document</dfn></h3><a class="self-link" href="#openapi-document" aria-label="Permalink for Section 3.1"></a></div>
<p>A self-contained or composite resource which defines or describes an API or elements of an API. The OpenAPI document <em class="rfc2119">MUST</em> contain at least one <a href="#paths-object">paths</a> field, a <a href="#oasComponents">components</a> field or a <a href="#oasWebhooks">webhooks</a> field. An OpenAPI document uses and conforms to the OpenAPI Specification.</p>
Expand Down Expand Up @@ -396,7 +395,7 @@ <h1 id="title" class="title">OpenAPI Specification v3.1.0 </h1> <h2 id="subtitle
<tr>
<td><span id="oasWebhooks"></span>webhooks</td>
<td style="text-align:center">Map[<code>string</code>, <a href="#path-item-object">Path Item Object</a> | <a href="#reference-object">Reference Object</a>] ]</td>
<td>The incoming webhooks that <em class="rfc2119">MAY</em> be received as part of this API and that the API consumer <em class="rfc2119">MAY</em> choose to implement. Closely related to the <code>callbacks</code> feature, this section describes requests initiated other than by an API call, for example by an out of band registration. The key name is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the expected responses. An <a href="https://learn.openapis.org/examples/v3.1/webhook-example.yaml">example</a> is available.</td>
<td>The incoming webhooks that <em class="rfc2119">MAY</em> be received as part of this API and that the API consumer <em class="rfc2119">MAY</em> choose to implement. Closely related to the <code>callbacks</code> feature, this section describes requests initiated other than by an API call, for example by an out of band registration. The key name is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the expected responses. An <a href="https://learn.openapis.org/examples/v3.1/webhook-example.html">example</a> is available.</td>
</tr>
<tr>
<td><span id="oasComponents"></span>components</td>
Expand Down Expand Up @@ -2471,7 +2470,7 @@ <h1 id="title" class="title">OpenAPI Specification v3.1.0 </h1> <h2 id="subtitle
<tr>
<td><span id="callbackExpression"></span>{expression}</td>
<td style="text-align:center"><a href="#path-item-object">Path Item Object</a> | <a href="#reference-object">Reference Object</a></td>
<td>A Path Item Object, or a reference to one, used to define a callback request and expected responses. A <a href="https://learn.openapis.org/examples/v3.0/callback-example.yaml">complete example</a> is available.</td>
<td>A Path Item Object, or a reference to one, used to define a callback request and expected responses. A <a href="https://learn.openapis.org/examples/v3.0/callback-example.html">complete example</a> is available.</td>
</tr>
</tbody>
</table>
Expand Down