Skip to content

Commit 254abae

Browse files
committed
Manually fix additional markdownlint problems
- heading levels aren't continuous MD001 - code fences need a language MD040 - table has the wrong number of cells MD056
1 parent d899954 commit 254abae

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

versions/3.0.4.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# OpenAPI Specification
22

3-
#### Version 3.0.4
3+
## Version 3.0.4
44

55
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [BCP 14](https://tools.ietf.org/html/bcp14) [RFC2119](https://tools.ietf.org/html/rfc2119) [RFC8174](https://tools.ietf.org/html/rfc8174) when, and only when, they appear in all capitals, as shown here.
66

@@ -71,30 +71,30 @@ For extension registries and other specifications published by the OpenAPI Initi
7171

7272
## Definitions
7373

74-
##### <a name="oasDocument"></a>OpenAPI Description
74+
### <a name="oasDocument"></a>OpenAPI Description
7575

7676
An OpenAPI Description (OAD) formally describes the surface of an API and its semantics. It is composed of an [entry document](#documentStructure) and any/all of its referenced documents. An OAD uses and conforms to the OpenAPI Specification.
7777

78-
##### <a name="definitionsSchema"></a>Schema
78+
### <a name="definitionsSchema"></a>Schema
7979

8080
A "schema" is a formal description of syntax and structure.
8181
This document serves as the [schema](#schema) for the OpenAPI Specification format; a non-authoritative JSON Schema based on this document is also provided on [spec.openapis.org](https://spec.openapis.org) for informational purposes.
8282
This specification also _uses_ schemas in the form of the [Schema Object](#schemaObject).
8383

84-
##### <a name="pathTemplating"></a>Path Templating
84+
### <a name="pathTemplating"></a>Path Templating
8585

8686
Path templating refers to the usage of template expressions, delimited by curly braces (`{}`), to mark a section of a URL path as replaceable using path parameters.
8787

8888
Each template expression in the path MUST correspond to a path parameter that is included in the [Path Item](#path-item-object) itself and/or in each of the Path Item's [Operations](#operation-object).
8989

90-
##### <a name="mediaTypes"></a>Media Types
90+
### <a name="mediaTypes"></a>Media Types
9191

9292
Media type definitions are spread across several resources.
9393
The media type definitions SHOULD be in compliance with [RFC6838](https://tools.ietf.org/html/rfc6838).
9494

9595
Some examples of possible media type definitions:
9696

97-
```
97+
```text
9898
text/plain; charset=utf-8
9999
application/json
100100
application/vnd.github+json
@@ -107,17 +107,17 @@ Some examples of possible media type definitions:
107107
application/vnd.github.v3.patch
108108
```
109109

110-
##### <a name="httpCodes"></a>HTTP Status Codes
110+
### <a name="httpCodes"></a>HTTP Status Codes
111111

112112
The HTTP Status Codes are used to indicate the status of the executed operation.
113113
Status codes SHOULD be selected from the available status codes registered in the [IANA Status Code Registry](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml).
114114

115-
##### <a name="httpAndCaseSensitivity"></a>HTTP and Case Sensitivity
115+
### <a name="httpAndCaseSensitivity"></a>HTTP and Case Sensitivity
116116

117117
As most field names and values in the OpenAPI Specification are case-sensitive, this document endeavors to call out any case-insensitive names and values.
118118
However, the case sensitivity of field names and values that map directly to HTTP concepts follow the case sensitivity rules of HTTP, even if this document does not make a note of every concept.
119119

120-
##### <a name="undefinedAndImplementationDefinedBehavior"></a>Undefined and Implementation-Defined Behavior
120+
### <a name="undefinedAndImplementationDefinedBehavior"></a>Undefined and Implementation-Defined Behavior
121121

122122
This specification deems certain situations to have either _undefined_ or _implementation-defined_ behavior.
123123

@@ -562,7 +562,7 @@ All the fixed fields declared above are objects that MUST use keys that match th
562562

563563
Field Name Examples:
564564

565-
```
565+
```text
566566
User
567567
User_1
568568
User_Name
@@ -761,21 +761,21 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
761761

762762
Assuming the following paths, the concrete definition, `/pets/mine`, will be matched first if used:
763763

764-
```
764+
```text
765765
/pets/{petId}
766766
/pets/mine
767767
```
768768

769769
The following paths are considered identical and invalid:
770770

771-
```
771+
```text
772772
/pets/{petId}
773773
/pets/{name}
774774
```
775775

776776
The following may lead to ambiguous resolution:
777777

778-
```
778+
```text
779779
/{entity}/me
780780
/books/{id}
781781
```
@@ -1175,7 +1175,7 @@ See [Appendix E](#percentEncodingAndFormMediaTypes) for a discussion of percent-
11751175

11761176
Assume a parameter named `color` has one of the following values:
11771177

1178-
```
1178+
```text
11791179
string -> "blue"
11801180
array -> ["blue","black","brown"]
11811181
object -> { "R": 100, "G": 200, "B": 150 }
@@ -2487,10 +2487,10 @@ The table below provides examples of runtime expressions and examples of their u
24872487
| Source Location | example expression | notes |
24882488
| --------------------- | :------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------- |
24892489
| HTTP Method | `$method` | The allowable values for the `$method` will be those for the HTTP operation. |
2490-
| Requested media type | `$request.header.accept` |
2490+
| Requested media type | `$request.header.accept` | |
24912491
| Request parameter | `$request.path.id` | Request parameters MUST be declared in the `parameters` section of the parent operation or they cannot be evaluated. This includes request headers. |
24922492
| Request body property | `$request.body#/user/uuid` | In operations which accept payloads, references may be made to portions of the `requestBody` or the entire body. |
2493-
| Request URL | `$url` |
2493+
| Request URL | `$url` ||
24942494
| Response value | `$response.body#/status` | In operations which return payloads, references may be made to portions of the response body or the entire body. |
24952495
| Response header | `$response.header.Server` | Single header values only are available |
24962496

0 commit comments

Comments
 (0)