Skip to content

Commit f3343c1

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

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

Diff for: versions/3.0.4.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,10 @@ In order to preserve the ability to round-trip between YAML and JSON formats, YA
146146

147147
### <a name="documentStructure"></a>OpenAPI Description Structure
148148

149-
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) and [Path Item Object](#pathItemObject) `$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.**
149+
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) and [Path Item Object](#pathItemObject) `$ref` keywords, as well as the [Link Object](#linkObject) `operationRef` keyword, are used.
150+
151+
Any document consisting entirely of an OpenAPI Object is known as a **complete OpenAPI document**.
152+
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**.
150153

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

0 commit comments

Comments
 (0)