Skip to content

Commit 6e7b1f5

Browse files
authored
Merge pull request #3927 from handrews/authoritative-304
Authoritative rendering; "schema" usage (3.0.4)
2 parents 396064d + a4d3575 commit 6e7b1f5

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

versions/3.0.4.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ An OpenAPI description can then be used by documentation generation tools to dis
1414

1515
For examples of OpenAPI usage and additional documentation, please visit [learn.openapis.org](https://learn.openapis.org/).
1616

17-
For extension registries and other specifications published by the OpenAPI Initiative, please visit [spec.openapis.org](https://spec.openapis.org/)
17+
For extension registries and other specifications published by the OpenAPI Initiative, as well as the authoritative rendering of this specification, please visit [spec.openapis.org](https://spec.openapis.org/).
1818

1919
## Table of Contents
2020
<!-- TOC depthFrom:1 depthTo:3 withLinks:1 updateOnSave:1 orderedList:0 -->
@@ -74,6 +74,12 @@ For extension registries and other specifications published by the OpenAPI Initi
7474
##### <a name="oasDocument"></a>OpenAPI Description
7575
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.
7676

77+
##### <a name="definitionsSchema"></a>Schema
78+
79+
A "schema" is a formal description of syntax and structure.
80+
This document serves as the [schema](#schema) for the OpenAPI Specification format; a non-authoritative JSON Schema based on this document is also provided on [spec.openapis.org](https://spec.openapis.org) for informational purposes.
81+
This specification also _uses_ schemas in the form of the [Schema Object](#schemaObject).
82+
7783
##### <a name="pathTemplating"></a>Path Templating
7884
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.
7985

@@ -142,7 +148,7 @@ For example, if a field has an array value, the JSON array representation will b
142148
All field names in the specification are **case sensitive**.
143149
This includes all fields that are used as keys in a map, except where explicitly noted that keys are **case insensitive**.
144150

145-
The schema exposes two types of fields: Fixed fields, which have a declared name, and Patterned fields, which declare a regex pattern for the field name.
151+
The [schema](#schema) exposes two types of fields: Fixed fields, which have a declared name, and Patterned fields, which declare a regex pattern for the field name.
146152

147153
Patterned fields MUST have unique names within the containing object.
148154

0 commit comments

Comments
 (0)