You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
</section></section><sectionid="introduction"><divclass="header-wrapper"><h2id="x2-introduction"><bdiclass="secno">2. </bdi>Introduction</h2><aclass="self-link" href="#introduction" aria-label="Permalink for Section 2."></a></div>
250
250
<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>
251
251
<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>
252
-
253
252
</section><sectionid="definitions"><divclass="header-wrapper"><h2id="x3-definitions"><bdiclass="secno">3. </bdi><dfnid="dfn-definitions" tabindex="0" aria-haspopup="dialog" data-dfn-type="dfn">Definitions</dfn></h2><aclass="self-link" href="#definitions" aria-label="Permalink for Section 3."></a></div>
<p>A self-contained or composite resource which defines or describes an API or elements of an API. The OpenAPI document <emclass="rfc2119">MUST</em> contain at least one <ahref="#paths-object">paths</a> field, a <ahref="#oasComponents">components</a> field or a <ahref="#oasWebhooks">webhooks</a> field. An OpenAPI document uses and conforms to the OpenAPI Specification.</p>
<td>The incoming webhooks that <emclass="rfc2119">MAY</em> be received as part of this API and that the API consumer <emclass="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 <ahref="https://learn.openapis.org/examples/v3.1/webhook-example.yaml">example</a> is available.</td>
398
+
<td>The incoming webhooks that <emclass="rfc2119">MAY</em> be received as part of this API and that the API consumer <emclass="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 <ahref="https://learn.openapis.org/examples/v3.1/webhook-example.html">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 <ahref="https://learn.openapis.org/examples/v3.0/callback-example.yaml">complete example</a> is available.</td>
2473
+
<td>A Path Item Object, or a reference to one, used to define a callback request and expected responses. A <ahref="https://learn.openapis.org/examples/v3.0/callback-example.html">complete example</a> is available.</td>
</section></section><sectionid="introduction"><divclass="header-wrapper"><h2id="x2-introduction"><bdiclass="secno">2. </bdi>Introduction</h2><aclass="self-link" href="#introduction" aria-label="Permalink for Section 2."></a></div>
235
235
<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>
236
236
<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>
237
-
238
237
</section><sectionid="definitions"><divclass="header-wrapper"><h2id="x3-definitions"><bdiclass="secno">3. </bdi><dfnid="dfn-definitions" tabindex="0" aria-haspopup="dialog" data-dfn-type="dfn">Definitions</dfn></h2><aclass="self-link" href="#definitions" aria-label="Permalink for Section 3."></a></div>
<td>A Path Item Object used to define a callback request and expected responses. A <ahref="https://learn.openapis.org/examples/v3.0/callback-example.yaml">complete example</a> is available.</td>
2447
+
<td>A Path Item Object used to define a callback request and expected responses. A <ahref="https://learn.openapis.org/examples/v3.0/callback-example.html">complete example</a> is available.</td>
</section></section><sectionid="introduction"><divclass="header-wrapper"><h2id="x2-introduction"><bdiclass="secno">2. </bdi>Introduction</h2><aclass="self-link" href="#introduction" aria-label="Permalink for Section 2."></a></div>
240
240
<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>
241
241
<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>
242
-
243
242
</section><sectionid="definitions"><divclass="header-wrapper"><h2id="x3-definitions"><bdiclass="secno">3. </bdi><dfnid="dfn-definitions" tabindex="0" aria-haspopup="dialog" data-dfn-type="dfn">Definitions</dfn></h2><aclass="self-link" href="#definitions" aria-label="Permalink for Section 3."></a></div>
<td>A Path Item Object used to define a callback request and expected responses. A <ahref="https://learn.openapis.org/examples/v3.0/callback-example.yaml">complete example</a> is available.</td>
2452
+
<td>A Path Item Object used to define a callback request and expected responses. A <ahref="https://learn.openapis.org/examples/v3.0/callback-example.html">complete example</a> is available.</td>
</section></section><sectionid="introduction"><divclass="header-wrapper"><h2id="x2-introduction"><bdiclass="secno">2. </bdi>Introduction</h2><aclass="self-link" href="#introduction" aria-label="Permalink for Section 2."></a></div>
250
250
<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>
251
251
<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>
252
-
253
252
</section><sectionid="definitions"><divclass="header-wrapper"><h2id="x3-definitions"><bdiclass="secno">3. </bdi><dfnid="dfn-definitions" tabindex="0" aria-haspopup="dialog" data-dfn-type="dfn">Definitions</dfn></h2><aclass="self-link" href="#definitions" aria-label="Permalink for Section 3."></a></div>
<td>A Path Item Object used to define a callback request and expected responses. A <ahref="https://learn.openapis.org/examples/v3.0/callback-example.yaml">complete example</a> is available.</td>
2471
+
<td>A Path Item Object used to define a callback request and expected responses. A <ahref="https://learn.openapis.org/examples/v3.0/callback-example.html">complete example</a> is available.</td>
</section></section><sectionid="introduction"><divclass="header-wrapper"><h2id="x2-introduction"><bdiclass="secno">2. </bdi>Introduction</h2><aclass="self-link" href="#introduction" aria-label="Permalink for Section 2."></a></div>
250
250
<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>
251
251
<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>
252
-
253
252
</section><sectionid="definitions"><divclass="header-wrapper"><h2id="x3-definitions"><bdiclass="secno">3. </bdi><dfnid="dfn-definitions" tabindex="0" aria-haspopup="dialog" data-dfn-type="dfn">Definitions</dfn></h2><aclass="self-link" href="#definitions" aria-label="Permalink for Section 3."></a></div>
<td>A Path Item Object used to define a callback request and expected responses. A <ahref="https://learn.openapis.org/examples/v3.0/callback-example.yaml">complete example</a> is available.</td>
2473
+
<td>A Path Item Object used to define a callback request and expected responses. A <ahref="https://learn.openapis.org/examples/v3.0/callback-example.html">complete example</a> is available.</td>
</section></section><sectionid="introduction"><divclass="header-wrapper"><h2id="x2-introduction"><bdiclass="secno">2. </bdi>Introduction</h2><aclass="self-link" href="#introduction" aria-label="Permalink for Section 2."></a></div>
250
250
<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>
251
251
<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>
252
-
253
252
</section><sectionid="definitions"><divclass="header-wrapper"><h2id="x3-definitions"><bdiclass="secno">3. </bdi><dfnid="dfn-definitions" tabindex="0" aria-haspopup="dialog" data-dfn-type="dfn">Definitions</dfn></h2><aclass="self-link" href="#definitions" aria-label="Permalink for Section 3."></a></div>
<p>A self-contained or composite resource which defines or describes an API or elements of an API. The OpenAPI document <emclass="rfc2119">MUST</em> contain at least one <ahref="#paths-object">paths</a> field, a <ahref="#oasComponents">components</a> field or a <ahref="#oasWebhooks">webhooks</a> field. An OpenAPI document uses and conforms to the OpenAPI Specification.</p>
<td>The incoming webhooks that <emclass="rfc2119">MAY</em> be received as part of this API and that the API consumer <emclass="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 <ahref="https://learn.openapis.org/examples/v3.1/webhook-example.yaml">example</a> is available.</td>
398
+
<td>The incoming webhooks that <emclass="rfc2119">MAY</em> be received as part of this API and that the API consumer <emclass="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 <ahref="https://learn.openapis.org/examples/v3.1/webhook-example.html">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 <ahref="https://learn.openapis.org/examples/v3.0/callback-example.yaml">complete example</a> is available.</td>
2473
+
<td>A Path Item Object, or a reference to one, used to define a callback request and expected responses. A <ahref="https://learn.openapis.org/examples/v3.0/callback-example.html">complete example</a> is available.</td>
0 commit comments