Skip to content

Commit

Permalink
Clarify entry/complete document terminology (3.0.4)
Browse files Browse the repository at this point in the history
Clarifies that there can be multiple complete OpenAPI documents,
only one of which is an entry OpenAPI document.
  • Loading branch information
handrews committed May 22, 2024
1 parent c069212 commit f3343c1
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion versions/3.0.4.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,10 @@ In order to preserve the ability to round-trip between YAML and JSON formats, YA

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

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.**
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.

Any document consisting entirely of an OpenAPI Object is known as a **complete OpenAPI document**.
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**.

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

Expand Down

0 comments on commit f3343c1

Please sign in to comment.