|
83 | 83 | <meta name="color-scheme" content="light">
|
84 | 84 | <link rel="canonical" href="https://spec.openapis.org/oas/v3.1.0.html">
|
85 | 85 | <style>
|
86 |
| -.hljs{--base:#fafafa;--mono-1:#383a42;--mono-2:#686b77;--mono-3:#717277;--hue-1:#0b76c5;--hue-2:#336ae3;--hue-3:#a626a4;--hue-4:#42803c;--hue-5:#ca4706;--hue-5-2:#c91243;--hue-6:#986801;--hue-6-2:#9a6a01} |
87 |
| -@media (prefers-color-scheme:dark){ |
88 |
| -.hljs{--base:#282c34;--mono-1:#abb2bf;--mono-2:#818896;--mono-3:#5c6370;--hue-1:#56b6c2;--hue-2:#61aeee;--hue-3:#c678dd;--hue-4:#98c379;--hue-5:#e06c75;--hue-5-2:#be5046;--hue-6:#d19a66;--hue-6-2:#e6c07b} |
89 |
| -} |
90 |
| -.hljs{display:block;overflow-x:auto;padding:.5em;color:#383a42;color:var(--mono-1,#383a42);background:#fafafa;background:var(--base,#fafafa)} |
91 |
| -.hljs-comment,.hljs-quote{color:#717277;color:var(--mono-3,#717277);font-style:italic} |
92 |
| -.hljs-doctag,.hljs-formula,.hljs-keyword{color:#a626a4;color:var(--hue-3,#a626a4)} |
93 |
| -.hljs-deletion,.hljs-name,.hljs-section,.hljs-selector-tag,.hljs-subst{color:#ca4706;color:var(--hue-5,#ca4706);font-weight:700} |
94 |
| -.hljs-literal{color:#0b76c5;color:var(--hue-1,#0b76c5)} |
95 |
| -.hljs-addition,.hljs-attribute,.hljs-meta-string,.hljs-regexp,.hljs-string{color:#42803c;color:var(--hue-4,#42803c)} |
96 |
| -.hljs-built_in,.hljs-class .hljs-title{color:#9a6a01;color:var(--hue-6-2,#9a6a01)} |
97 |
| -.hljs-attr,.hljs-number,.hljs-selector-attr,.hljs-selector-class,.hljs-selector-pseudo,.hljs-template-variable,.hljs-type,.hljs-variable{color:#986801;color:var(--hue-6,#986801)} |
98 |
| -.hljs-bullet,.hljs-link,.hljs-meta,.hljs-selector-id,.hljs-symbol,.hljs-title{color:#336ae3;color:var(--hue-2,#336ae3)} |
99 |
| -.hljs-emphasis{font-style:italic} |
100 |
| -.hljs-strong{font-weight:700} |
101 |
| -.hljs-link{text-decoration:underline} |
102 |
| -</style> |
103 |
| -<style> |
104 | 86 | var{position:relative;cursor:pointer}
|
105 | 87 | var[data-type]::after,var[data-type]::before{position:absolute;left:50%;top:-6px;opacity:0;transition:opacity .4s;pointer-events:none}
|
106 | 88 | var[data-type]::before{content:"";transform:translateX(-50%);border-width:4px 6px 0 6px;border-style:solid;border-color:transparent;border-top-color:#222}
|
@@ -260,7 +242,7 @@ <h1 id="title" class="title">OpenAPI Specification v3.1.0 </h1> <h2 id="subtitle
|
260 | 242 | <p>Media type definitions are spread across several resources.
|
261 | 243 | The media type definitions <em class="rfc2119">SHOULD</em> be in compliance with [<cite><a class="bibref" data-link-type="biblio" href="#bib-rfc6838" title="Media Type Specifications and Registration Procedures">RFC6838</a></cite>].</p>
|
262 | 244 | <p>Some examples of possible media type definitions:</p>
|
263 |
| -<pre class="highlight " tabindex="0"><code aria-busy="false" class="hljs"> text/plain; charset=utf-8 |
| 245 | +<pre class="nohighlight" tabindex="0"><code> text/plain; charset=utf-8 |
264 | 246 | application/json
|
265 | 247 | application/vnd.github+json
|
266 | 248 | application/vnd.github.v3+json
|
@@ -789,7 +771,7 @@ <h1 id="title" class="title">OpenAPI Specification v3.1.0 </h1> <h2 id="subtitle
|
789 | 771 | <p>This object <em class="rfc2119">MAY</em> be extended with <a href="#specification-extensions">Specification Extensions</a>.</p>
|
790 | 772 | <p>All the fixed fields declared above are objects that <em class="rfc2119">MUST</em> use keys that match the regular expression: <code>^[a-zA-Z0-9\.\-_]+$</code>.</p>
|
791 | 773 | <p>Field Name Examples:</p>
|
792 |
| -<pre class="highlight " tabindex="0"><code aria-busy="false" class="hljs">User |
| 774 | +<pre class="nohighlight" tabindex="0"><code>User |
793 | 775 | User_1
|
794 | 776 | User_Name
|
795 | 777 | user-name
|
@@ -987,15 +969,15 @@ <h1 id="title" class="title">OpenAPI Specification v3.1.0 </h1> <h2 id="subtitle
|
987 | 969 | <p>This object <em class="rfc2119">MAY</em> be extended with <a href="#specification-extensions">Specification Extensions</a>.</p>
|
988 | 970 | </section><section id="path-templating-matching"><div class="header-wrapper"><h5 id="x4-8-8-2-path-templating-matching"><bdi class="secno">4.8.8.2 </bdi>Path Templating Matching</h5><a class="self-link" href="#path-templating-matching" aria-label="Permalink for Section 4.8.8.2"></a></div>
|
989 | 971 | <p>Assuming the following paths, the concrete definition, <code>/pets/mine</code>, will be matched first if used:</p>
|
990 |
| -<pre class="highlight " tabindex="0"><code aria-busy="false" class="hljs"> /pets/{petId} |
| 972 | +<pre class="nohighlight" tabindex="0"><code> /pets/{petId} |
991 | 973 | /pets/mine
|
992 | 974 | </code></pre>
|
993 | 975 | <p>The following paths are considered identical and invalid:</p>
|
994 |
| -<pre class="highlight " tabindex="0"><code aria-busy="false" class="hljs"> /pets/{petId} |
| 976 | +<pre class="nohighlight" tabindex="0"><code> /pets/{petId} |
995 | 977 | /pets/{name}
|
996 | 978 | </code></pre>
|
997 | 979 | <p>The following may lead to ambiguous resolution:</p>
|
998 |
| -<pre class="highlight " tabindex="0"><code aria-busy="false" class="hljs"> /{entity}/me |
| 980 | +<pre class="nohighlight" tabindex="0"><code> /{entity}/me |
999 | 981 | /books/{id}
|
1000 | 982 | </code></pre>
|
1001 | 983 | </section><section id="paths-object-example"><div class="header-wrapper"><h5 id="x4-8-8-3-paths-object-example"><bdi class="secno">4.8.8.3 </bdi>Paths Object Example</h5><a class="self-link" href="#paths-object-example" aria-label="Permalink for Section 4.8.8.3"></a></div>
|
@@ -1583,9 +1565,9 @@ <h1 id="title" class="title">OpenAPI Specification v3.1.0 </h1> <h2 id="subtitle
|
1583 | 1565 | </table>
|
1584 | 1566 | </section><section id="style-examples"><div class="header-wrapper"><h5 id="x4-8-12-4-style-examples"><bdi class="secno">4.8.12.4 </bdi>Style Examples</h5><a class="self-link" href="#style-examples" aria-label="Permalink for Section 4.8.12.4"></a></div>
|
1585 | 1567 | <p>Assume a parameter named <code>color</code> has one of the following values:</p>
|
1586 |
| -<pre class="highlight " tabindex="0"><code aria-busy="false" class="hljs css"> string -> "blue" |
1587 |
| - array -> <span class="hljs-selector-attr">[<span class="hljs-string">"blue"</span>,<span class="hljs-string">"black"</span>,<span class="hljs-string">"brown"</span>]</span> |
1588 |
| - <span class="hljs-selector-tag">object</span> -> { "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> } |
| 1568 | +<pre class="nohighlight" tabindex="0"><code> string -> "blue" |
| 1569 | + array -> ["blue","black","brown"] |
| 1570 | + object -> { "R": 100, "G": 200, "B": 150 } |
1589 | 1571 | </code></pre>
|
1590 | 1572 | <p>The following table shows examples of rendering differences for each value.</p>
|
1591 | 1573 | <table>
|
@@ -2486,17 +2468,17 @@ <h1 id="title" class="title">OpenAPI Specification v3.1.0 </h1> <h2 id="subtitle
|
2486 | 2468 | <span class="hljs-attribute">Content-Type</span><span class="hljs-punctuation">: </span>application/json
|
2487 | 2469 | <span class="hljs-attribute">Content-Length</span><span class="hljs-punctuation">: </span>187
|
2488 | 2470 |
|
2489 |
| -<span class="language-avrasm">{ |
2490 |
| - <span class="hljs-string">"failedUrl"</span> : <span class="hljs-string">"https://clientdomain.com/failed"</span>, |
2491 |
| - <span class="hljs-string">"successUrls"</span> : [ |
2492 |
| - <span class="hljs-string">"https://clientdomain.com/fast"</span>, |
2493 |
| - <span class="hljs-string">"https://clientdomain.com/medium"</span>, |
2494 |
| - <span class="hljs-string">"https://clientdomain.com/slow"</span> |
| 2471 | +<span class="language-uri">{ |
| 2472 | + "failedUrl" : "https://<span class="hljs-attr">clientdomain.com</span>/<span class="hljs-attr">failed",</span> |
| 2473 | + "successUrls" : [ |
| 2474 | + "https://<span class="hljs-attr">clientdomain.com</span>/<span class="hljs-attr">fast",</span> |
| 2475 | + "https://<span class="hljs-attr">clientdomain.com</span>/<span class="hljs-attr">medium",</span> |
| 2476 | + "https://<span class="hljs-attr">clientdomain.com</span>/<span class="hljs-attr">slow"</span> |
2495 | 2477 | ]
|
2496 | 2478 | }
|
2497 | 2479 |
|
2498 |
| -<span class="hljs-number">201</span> Created |
2499 |
| -<span class="hljs-symbol">Location:</span> https://example<span class="hljs-meta">.org</span>/subscription/<span class="hljs-number">1</span> |
| 2480 | +201 Created |
| 2481 | +Location: https://<span class="hljs-attr">example.org</span>/<span class="hljs-attr">subscription</span>/<span class="hljs-attr">1</span> |
2500 | 2482 | </span></code></pre>
|
2501 | 2483 | <p>The following examples show how the various expressions evaluate, assuming the callback operation has a path parameter named <code>eventType</code> and a query parameter named <code>queryUrl</code>.</p>
|
2502 | 2484 | <table>
|
|
0 commit comments