Skip to content

Commit 618b67c

Browse files
ralfhandlMikeRalphson
authored andcommitted
structure.md: entry document called openapi.json
"one or more text documents" doesn't rhyme with "commonly called <single filename>". Move common filename down to "entry document".
1 parent cbd45e0 commit 618b67c

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

specification/structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ An OpenAPI Description (OAD) describes an HTTP-like API in one or more machine-r
1111

1212
## OpenAPI Description Syntax
1313

14-
OpenAPI Descriptions are written as one or more text documents, commonly called `openapi.json` or `openapi.yaml`. Each document represents a [JSON](https://en.wikipedia.org/wiki/JSON) object, in either JSON or [YAML](https://en.wikipedia.org/wiki/YAML) format. **References** are used to link parts of the JSON object(s) to each other, and this linked structure is the complete OpenAPI Description. Parsing begins with an [OpenAPI Object](https://spec.openapis.org/oas/v3.1.0#openapi-object), and the document containing that object is known as the **entry document**.
14+
OpenAPI Descriptions are written as one or more text documents. Each document represents a [JSON](https://en.wikipedia.org/wiki/JSON) object, in either JSON or [YAML](https://en.wikipedia.org/wiki/YAML) format. **References** are used to link parts of the JSON object(s) to each other, and this linked structure is the complete OpenAPI Description. Parsing begins with an [OpenAPI Object](https://spec.openapis.org/oas/v3.1.0#openapi-object), and the document containing that object is known as the **entry document**, commonly called `openapi.json` or `openapi.yaml`.
1515

1616
This section very briefly describes and compares the JSON and YAML data formats.
1717

0 commit comments

Comments
 (0)