Skip to content

Commit 95ceb03

Browse files
authored
Merge pull request #4077 from handrews/complete-contained-304
Clarify complete vs self-contained documents
2 parents bac02c0 + c11668c commit 95ceb03

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

versions/3.0.4.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,9 @@ In order to preserve the ability to round-trip between YAML and JSON formats, YA
121121

122122
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](#reference-object) and [Path Item Object](#path-item-object) `$ref` keywords, as well as the [Link Object](#link-object) `operationRef` keyword, are used.
123123

124-
Any document consisting entirely of an [OpenAPI Object](#openapi-object) is known as a **complete OpenAPI document**.
124+
Any document consisting entirely of an [OpenAPI Object](#openapi-object) is known as a **syntactically complete OpenAPI document**.
125+
An OpenAPI document that does _not_ reference any other documents is known as a **self-contained OpenAPI document**.
126+
A single-document description is therefore _both_ syntactically complete _and_ self-contained.
125127
In a multi-document description, the document containing the OpenAPI Object where parsing begins for a specific API's description is known as that API's **entry OpenAPI document**, or simply **entry document**.
126128

127129
It is RECOMMENDED that the entry OpenAPI document be named: `openapi.json` or `openapi.yaml`.
@@ -130,7 +132,7 @@ It is RECOMMENDED that the entry OpenAPI document be named: `openapi.json` or `o
130132

131133
When parsing an OAD, JSON or YAML objects are parsed into specific Objects (such as [Operation Objects](#operation-object), [Response Objects](#response-object), [Reference Objects](#reference-object), etc.) based on the parsing context. Depending on how references are arranged, a given JSON or YAML object can be parsed in multiple different contexts:
132134

133-
* As a complete OpenAPI Description document
135+
* As a syntactically complete OpenAPI Description document
134136
* As the Object type implied by its parent Object within the document
135137
* As a reference target, with the Object type matching the reference source's context
136138

0 commit comments

Comments
 (0)