|
165 | 165 | "publishISODate": "2014-09-08T00:00:00.000Z",
|
166 | 166 | "generatedSubtitle": "08 September 2014"
|
167 | 167 | }</script>
|
168 |
| -<link rel="stylesheet" href="https://www.w3.org/StyleSheets/TR/2021/base.css"></head><body class="h-entry"><div class="head"> |
| 168 | +<link rel="stylesheet" href="https://www.w3.org/StyleSheets/TR/2021/base.css"></head><body class="h-entry toc-inline"><div class="head"> |
169 | 169 | <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">
|
170 | 170 | </a></p>
|
171 | 171 | <h1 id="title" class="title">OpenAPI Specification v2.0 </h1> <h2 id="subtitle" class="subtitle">Version 2.0</h2>
|
@@ -218,7 +218,7 @@ <h1 id="title" class="title">OpenAPI Specification v2.0 </h1> <h2 id="subtitle"
|
218 | 218 | <section id="openapi-specification"><div class="header-wrapper"><h2 id="x1-openapi-specification"><bdi class="secno">1. </bdi>OpenAPI Specification</h2><a class="self-link" href="#openapi-specification" aria-label="Permalink for Section 1."></a></div>
|
219 | 219 | </section><section id="fka-swagger-restful-api-documentation-specification"><div class="header-wrapper"><h2 id="x2-fka-swagger-restful-api-documentation-specification"><bdi class="secno">2. </bdi>(fka Swagger RESTful API Documentation Specification)</h2><a class="self-link" href="#fka-swagger-restful-api-documentation-specification" aria-label="Permalink for Section 2."></a></div>
|
220 | 220 | <section class="override" id="conformance"><div class="header-wrapper"><h3 id="x2-1-version-2-0"><bdi class="secno">2.1 </bdi>Version 2.0</h3><a class="self-link" href="#conformance" aria-label="Permalink for Section 2.1"></a></div>
|
221 |
| -<p>The key words “<em class="rfc2119">MUST</em>”, “<em class="rfc2119">MUST NOT</em>”, “<em class="rfc2119">REQUIRED</em>”, “<em class="rfc2119">SHALL</em>”, “<em class="rfc2119">SHALL NOT</em>”, “<em class="rfc2119">SHOULD</em>”, “<em class="rfc2119">SHOULD NOT</em>”, “<em class="rfc2119">RECOMMENDED</em>”, “<em class="rfc2119">MAY</em>”, and “<em class="rfc2119">OPTIONAL</em>” in this document are to be interpreted as described in <a href="http://www.ietf.org/rfc/rfc2119.txt">[RFC2119]</a>.</p> |
| 221 | +<p>The key words “<em class="rfc2119">MUST</em>”, “<em class="rfc2119">MUST NOT</em>”, “<em class="rfc2119">REQUIRED</em>”, “<em class="rfc2119">SHALL</em>”, “<em class="rfc2119">SHALL NOT</em>”, “<em class="rfc2119">SHOULD</em>”, “<em class="rfc2119">SHOULD NOT</em>”, “<em class="rfc2119">RECOMMENDED</em>”, “<em class="rfc2119">MAY</em>”, and “<em class="rfc2119">OPTIONAL</em>” in this document are to be interpreted as described in [<cite><a class="bibref" data-link-type="biblio" href="#bib-rfc2119" title="Key words for use in RFCs to Indicate Requirement Levels">RFC2119</a></cite>].</p> |
222 | 222 | <p>The Swagger specification is licensed under <a href="http://www.apache.org/licenses/LICENSE-2.0.html">The Apache License, Version 2.0</a>.</p>
|
223 | 223 | </section></section><section id="introductions"><div class="header-wrapper"><h2 id="x3-introductions"><bdi class="secno">3. </bdi>Introductions</h2><a class="self-link" href="#introductions" aria-label="Permalink for Section 3."></a></div>
|
224 | 224 | <p>Swagger™ is a project used to describe and document RESTful APIs.</p>
|
@@ -274,7 +274,7 @@ <h1 id="title" class="title">OpenAPI Specification v2.0 </h1> <h2 id="subtitle"
|
274 | 274 | application/vnd.github.v3.patch
|
275 | 275 | </code></pre>
|
276 | 276 | </section><section id="http-status-codes"><div class="header-wrapper"><h3 id="x5-3-http-status-codes"><bdi class="secno">5.3 </bdi><dfn id="dfn-http-status-codes" tabindex="0" aria-haspopup="dialog" data-dfn-type="dfn">HTTP Status Codes</dfn></h3><a class="self-link" href="#http-status-codes" aria-label="Permalink for Section 5.3"></a></div>
|
277 |
| -<p>The HTTP Status Codes are used to indicate the status of the executed operation. The available status codes are described by [<cite><a class="bibref" data-link-type="biblio" href="#bib-rfc7231" title="Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content">RFC7231</a></cite>] and in the <a href="http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml">IANA Status Code Registry</a>.</p> |
| 277 | +<p>The HTTP Status Codes are used to indicate the status of the executed operation. The available status codes are described by [<cite><a class="bibref" data-link-type="biblio" href="#bib-rfc7231" title="Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content">RFC7231</a></cite>] <a href="https://datatracker.ietf.org/doc/html/rfc7231#section-6">Section 6</a> and in the <a href="http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml">IANA Status Code Registry</a>.</p> |
278 | 278 | </section></section><section id="specification"><div class="header-wrapper"><h2 id="x6-specification"><bdi class="secno">6. </bdi>Specification</h2><a class="self-link" href="#specification" aria-label="Permalink for Section 6."></a></div>
|
279 | 279 | <section id="format"><div class="header-wrapper"><h3 id="x6-1-format"><bdi class="secno">6.1 </bdi>Format</h3><a class="self-link" href="#format" aria-label="Permalink for Section 6.1"></a></div>
|
280 | 280 | <p>The files describing the RESTful API in accordance with the Swagger specification are represented as JSON objects and conform to the JSON standards. YAML, being a superset of JSON, can be used as well to
|
@@ -357,13 +357,13 @@ <h1 id="title" class="title">OpenAPI Specification v2.0 </h1> <h2 id="subtitle"
|
357 | 357 | <td>date</td>
|
358 | 358 | <td><code>string</code></td>
|
359 | 359 | <td><code>date</code></td>
|
360 |
| -<td>As defined by <code>full-date</code> - <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6">[RFC3339]</a></td> |
| 360 | +<td>As defined by <code>full-date</code> - [<cite><a class="bibref" data-link-type="biblio" href="#bib-rfc3339" title="Date and Time on the Internet: Timestamps">RFC3339</a></cite>] <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6">Section 5.6</a></td> |
361 | 361 | </tr>
|
362 | 362 | <tr>
|
363 | 363 | <td>dateTime</td>
|
364 | 364 | <td><code>string</code></td>
|
365 | 365 | <td><code>date-time</code></td>
|
366 |
| -<td>As defined by <code>date-time</code> - <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6">[RFC3339]</a></td> |
| 366 | +<td>As defined by <code>date-time</code> - [<cite><a class="bibref" data-link-type="biblio" href="#bib-rfc3339" title="Date and Time on the Internet: Timestamps">RFC3339</a></cite>] <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6">Section 5.6</a></td> |
367 | 367 | </tr>
|
368 | 368 | <tr>
|
369 | 369 | <td>password</td>
|
@@ -2076,7 +2076,7 @@ <h1 id="title" class="title">OpenAPI Specification v2.0 </h1> <h2 id="subtitle"
|
2076 | 2076 | </code></pre>
|
2077 | 2077 | </section></section><section id="reference-object"><div class="header-wrapper"><h4 id="x6-4-17-reference-object"><bdi class="secno">6.4.17 </bdi>Reference Object</h4><a class="self-link" href="#reference-object" aria-label="Permalink for Section 6.4.17"></a></div>
|
2078 | 2078 | <p>A simple object to allow referencing other definitions in the specification. It can be used to reference parameters and responses that are defined at the top level for reuse.</p>
|
2079 |
| -<p>The Reference Object is a <a href="https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-02">JSON Reference</a> that uses a <a href="http://tools.ietf.org/html/rfc6901">JSON Pointer</a> as its value. For this specification, only <a href="https://tools.ietf.org/html/draft-zyp-json-schema-04#section-7.2.3">canonical dereferencing</a> is supported.</p> |
| 2079 | +<p>The Reference Object is a <a href="https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-02">JSON Reference</a> that uses a JSON Pointer [<cite><a class="bibref" data-link-type="biblio" href="#bib-rfc6901" title="JavaScript Object Notation (JSON) Pointer">RFC6901</a></cite>] as its value. For this specification, only <a href="https://tools.ietf.org/html/draft-zyp-json-schema-04#section-7.2.3">canonical dereferencing</a> is supported.</p> |
2080 | 2080 | <section id="fixed-fields-11"><div class="header-wrapper"><h5 id="x6-4-17-1-fixed-fields"><bdi class="secno">6.4.17.1 </bdi>Fixed Fields</h5><a class="self-link" href="#fixed-fields-11" aria-label="Permalink for Section 6.4.17.1"></a></div>
|
2081 | 2081 | <table>
|
2082 | 2082 | <thead>
|
@@ -3309,8 +3309,14 @@ <h1 id="title" class="title">OpenAPI Specification v2.0 </h1> <h2 id="subtitle"
|
3309 | 3309 |
|
3310 | 3310 | </section></section><section id="references" class="appendix"><div class="header-wrapper"><h2 id="a-references"><bdi class="secno">A. </bdi>References</h2><a class="self-link" href="#references" aria-label="Permalink for Appendix A."></a></div><section id="normative-references"><div class="header-wrapper"><h3 id="a-1-normative-references"><bdi class="secno">A.1 </bdi>Normative references</h3><a class="self-link" href="#normative-references" aria-label="Permalink for Appendix A.1"></a></div>
|
3311 | 3311 |
|
3312 |
| - <dl class="bibliography"><dt id="bib-rfc6838">[RFC6838]</dt><dd> |
| 3312 | + <dl class="bibliography"><dt id="bib-rfc2119">[RFC2119]</dt><dd> |
| 3313 | + <a href="https://www.rfc-editor.org/rfc/rfc2119"><cite>Key words for use in RFCs to Indicate Requirement Levels</cite></a>. S. Bradner. IETF. March 1997. Best Current Practice. URL: <a href="https://www.rfc-editor.org/rfc/rfc2119">https://www.rfc-editor.org/rfc/rfc2119</a> |
| 3314 | + </dd><dt id="bib-rfc3339">[RFC3339]</dt><dd> |
| 3315 | + <a href="https://www.rfc-editor.org/rfc/rfc3339"><cite>Date and Time on the Internet: Timestamps</cite></a>. G. Klyne; C. Newman. IETF. July 2002. Proposed Standard. URL: <a href="https://www.rfc-editor.org/rfc/rfc3339">https://www.rfc-editor.org/rfc/rfc3339</a> |
| 3316 | + </dd><dt id="bib-rfc6838">[RFC6838]</dt><dd> |
3313 | 3317 | <a href="https://www.rfc-editor.org/rfc/rfc6838"><cite>Media Type Specifications and Registration Procedures</cite></a>. N. Freed; J. Klensin; T. Hansen. IETF. January 2013. Best Current Practice. URL: <a href="https://www.rfc-editor.org/rfc/rfc6838">https://www.rfc-editor.org/rfc/rfc6838</a>
|
| 3318 | + </dd><dt id="bib-rfc6901">[RFC6901]</dt><dd> |
| 3319 | + <a href="https://www.rfc-editor.org/rfc/rfc6901"><cite>JavaScript Object Notation (JSON) Pointer</cite></a>. P. Bryan, Ed.; K. Zyp; M. Nottingham, Ed.. IETF. April 2013. Proposed Standard. URL: <a href="https://www.rfc-editor.org/rfc/rfc6901">https://www.rfc-editor.org/rfc/rfc6901</a> |
3314 | 3320 | </dd><dt id="bib-rfc7231">[RFC7231]</dt><dd>
|
3315 | 3321 | <a href="https://httpwg.org/specs/rfc7231.html"><cite>Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content</cite></a>. R. Fielding, Ed.; J. Reschke, Ed.. IETF. June 2014. Proposed Standard. URL: <a href="https://httpwg.org/specs/rfc7231.html">https://httpwg.org/specs/rfc7231.html</a>
|
3316 | 3322 | </dd></dl>
|
|
0 commit comments