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
This follows up from a discussion on the OAI slack that decided:
* redefining "document" to sometimes mean multiple documents is confusing
* "description" has more support than "definition"
A document (or set of documents) that describes an API. An OpenAPI Description (OAD) uses and conforms to the OpenAPI Specification.
72
72
73
73
##### <aname="pathTemplating"></a>Path Templating
74
74
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.
@@ -135,9 +135,9 @@ In order to preserve the ability to round-trip between YAML and JSON formats, YA
135
135
136
136
**Note:** While APIs may be defined by OpenAPI documents in either YAML or JSON format, the API request and response bodies and other content are not required to be JSON or YAML.
An OpenAPI document MAY be made up of a single document or be divided into multiple, connected parts at the discretion of the user. In the latter case, `$ref` fields MUST be used in the specification to reference those parts as follows from the [JSON Schema](https://json-schema.org) definitions.
140
+
An OpenAPI Description MAY be made up of a single document or be divided into multiple, connected parts at the discretion of the author. In the latter case, `$ref` fields MUST be used in the specification to reference those parts as follows from the [JSON Schema](https://json-schema.org) definitions. In a multi-document description, the document containing the [OpenAPI Object](#oasObject) is known as the **root OpenAPI document.**
141
141
142
142
It is RECOMMENDED that the root OpenAPI document be named: `openapi.json` or `openapi.yaml`.
0 commit comments