Skip to content

Describe OpenAPI entry point in OpenAPI description docs #3387

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Feb 1, 2024
Merged

Describe OpenAPI entry point in OpenAPI description docs #3387

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
26fe1eb
Describe OpenAPI entry point in OpenAPI description docs
duncanbeevers Sep 28, 2023
a441078
fixup! Describe OpenAPI entry point in OpenAPI description docs
duncanbeevers Sep 28, 2023
529a197
Update versions/3.1.1.md
darrelmiller Feb 1, 2024
f407f8c
fence braces with backticks
earth2marsh Feb 1, 2024
4911891
wordsmithing
earth2marsh Feb 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions versions/3.1.1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,10 @@ An OpenAPI definition can then be used by documentation generation tools to disp
## Definitions

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

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

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.

Expand Down