Skip to content

Commit 1c848b2

Browse files
authored
Merge pull request #3387 from duncanbeevers/docs/split-identity-and-composition
merging after discussion on the TDC call today
2 parents ea440c5 + 4911891 commit 1c848b2

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

versions/3.1.1.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -69,10 +69,10 @@ An OpenAPI definition can then be used by documentation generation tools to disp
6969
## Definitions
7070

7171
##### <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.
72+
An OpenAPI Description (OAD) formally describes the surface of an API and its semantics. It is composed of an [entry document](#documentStructure) and any/all of its referenced documents. An 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
75-
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.
75+
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.
7676

7777
Each template expression in the path MUST correspond to a path parameter that is included in the [Path Item](#path-item-object) itself and/or in each of the Path Item's [Operations](#operation-object). An exception is if the path item is empty, for example due to ACL constraints, matching path parameters are not required.
7878

0 commit comments

Comments
 (0)