Skip to content

Commit fb0955f

Browse files
authored
Settle on "OpenAPI Description" (3.1.1) (#3385)
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"
1 parent 6f44501 commit fb0955f

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

versions/3.1.1.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ An OpenAPI definition can then be used by documentation generation tools to disp
1616
<!-- TOC depthFrom:1 depthTo:3 withLinks:1 updateOnSave:1 orderedList:0 -->
1717

1818
- [Definitions](#definitions)
19-
- [OpenAPI Document](#oasDocument)
19+
- [OpenAPI Description](#oasDocument)
2020
- [Path Templating](#pathTemplating)
2121
- [Media Types](#mediaTypes)
2222
- [HTTP Status Codes](#httpCodes)
2323
- [Specification](#specification)
2424
- [Versions](#versions)
2525
- [Format](#format)
26-
- [Document Structure](#documentStructure)
26+
- [OpenAPI Description Structure](#documentStructure)
2727
- [Data Types](#dataTypes)
2828
- [Rich Text Formatting](#richText)
2929
- [Relative References In URIs](#relativeReferencesURI)
@@ -68,8 +68,8 @@ An OpenAPI definition can then be used by documentation generation tools to disp
6868

6969
## Definitions
7070

71-
##### <a name="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.
71+
##### <a name="oasDocument"></a>OpenAPI Description
72+
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.
7373

7474
##### <a name="pathTemplating"></a>Path Templating
7575
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
134134

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

137-
### <a name="documentStructure"></a>Document Structure
137+
### <a name="documentStructure"></a>OpenAPI Description Structure
138138

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

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`.
142142

143143
### <a name="dataTypes"></a>Data Types
144144

0 commit comments

Comments
 (0)