Skip to content

Commit a1a4468

Browse files
committed
Clarify entry/complete document terminology (3.1.1)
Clarifies that there can be multiple complete OpenAPI documents, only one of which is an entry OpenAPI document.
1 parent 46228b7 commit a1a4468

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

versions/3.1.1.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,10 @@ In order to preserve the ability to round-trip between YAML and JSON formats, YA
149149

150150
### <a name="documentStructure"></a>OpenAPI Description Structure
151151

152-
An OpenAPI Description (OAD) 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 Object](#referenceObject), [Path Item Object](#pathItemObject) and [Schema Object](#schemaObject) `$ref` keywords, as well as the [Link Object](#linkObject) `operationRef` keyword, are used. In a multi-document description, the document containing the [OpenAPI Object](#oasObject) is known as the **entry OpenAPI document.**
152+
An OpenAPI Description (OAD) 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 Object](#referenceObject), [Path Item Object](#pathItemObject) and [Schema Object](#schemaObject) `$ref` keywords, as well as the [Link Object](#linkObject) `operationRef` keyword, are used.
153+
154+
Any document consisting entirely of an OpenAPI Object is known as a **complete OpenAPI document**.
155+
In a multi-document description, the document containing the [OpenAPI Object](#oasObject) where parsing begins for a specific API's description is known as that API's **entry OpenAPI document**, or simply **entry document**.
153156

154157
It is RECOMMENDED that the entry OpenAPI document be named: `openapi.json` or `openapi.yaml`.
155158

0 commit comments

Comments
 (0)