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"
- [Relative References In URIs](#relativeReferencesURI)
@@ -68,8 +68,8 @@ An OpenAPI definition can then be used by documentation generation tools to disp
68
68
69
69
## Definitions
70
70
71
-
##### <aname="oasDocument"></a>OpenAPI Document
72
-
A self-contained or composite resource which defines or describes an API or elements of an API. The OpenAPI document MUST contain at least one [paths](#pathsObject) field, a [components](#oasComponents) field or a [webhooks](#oasWebhooks) field. An OpenAPI document uses and conforms to the OpenAPI Specification.
A document (or set of documents) that describes an API. An OpenAPI Description (OAD) uses and conforms to the OpenAPI Specification, and MUST contain at least one [paths](#pathsObject) field, [components](#oasComponents) field, or [webhooks](#oasWebhooks) field.
73
73
74
74
##### <aname="pathTemplating"></a>Path Templating
75
75
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.
@@ -134,11 +134,11 @@ In order to preserve the ability to round-trip between YAML and JSON formats, YA
134
134
135
135
**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 author. In the latter case, [`Reference Objects`](#referenceObject) and [`Schema Object`](#schemaObject)`$ref` keywords are used.
139
+
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, [`Reference Objects`](#referenceObject) and [`Schema Object`](#schemaObject)`$ref` keywords are used. In a multi-document description, the document containing the [OpenAPI Object](#oasObject) is known as the **entry OpenAPI document.**
140
140
141
-
It is RECOMMENDED that the root OpenAPI document be named: `openapi.json` or `openapi.yaml`.
141
+
It is RECOMMENDED that the entry OpenAPI document be named: `openapi.json` or `openapi.yaml`.
0 commit comments