Skip to content
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

Jump to bottom

Various minor editorial improvements (3.0.4) #3861

Merged
merged 15 commits into from
Jun 11, 2024
Merged

Various minor editorial improvements (3.0.4) #3861

Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
00b75dd
Link to the Learn and Spec sites
handrews May 27, 2024
ce05949
Clarify "Schema"
handrews May 27, 2024
41d2a52
Global HTTP case-(in)sensitivity rule
handrews May 27, 2024
79ed972
Improved description of XML examples
handrews May 27, 2024
02df675
Clarify CommonMark extensibility.
handrews May 27, 2024
4cdcab3
Add description to the Example Object
handrews May 27, 2024
9b49821
Mention the format registry in the data types section
handrews Jun 3, 2024
7e141bb
Wording improvement (review feedback)
handrews Jun 4, 2024
d6b71cd
Note extension registry in extensions section.
handrews Jun 4, 2024
96f8989
Better wording from review feedback
handrews Jun 4, 2024
f9dc67b
Better formatting (review feedback)
handrews Jun 4, 2024
e25e23c
better formatting (review feedback)
handrews Jun 4, 2024
43618e2
Warn of interop issues w/Markdown extensions
handrews Jun 5, 2024
f9813cd
Clarify version (Info Object) further
handrews Jun 5, 2024
fdb9570
Clarify confusing use of YAML "JSON Schema"
handrews Jun 8, 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
2 changes: 2 additions & 0 deletions versions/3.0.4.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,8 @@ Models are defined using the [Schema Object](#schemaObject), which is an extende
OAS uses several known formats to define in fine detail the data type being used.
However, to support documentation needs, the `format` property is an open `string`-valued property, and can have any value.
Formats such as `"email"`, `"uuid"`, and so on, MAY be used even though they are not defined by this specification.
The OpenAPI Initiative also hosts a [Format Registry](https://spec.openapis.org/registry/format/) for formats defined by OAS users and other specifications. Support for any registry format is strictly OPTIONAL, and support for one registry format does not imply support for any others.
handrews marked this conversation as resolved.
Show resolved Hide resolved

Types that are not accompanied by a `format` property follow the type definition in the JSON Schema. Tools that do not recognize a specific `format` MAY default back to the `type` alone, as if the `format` is not specified.

The formats defined by the OAS are:
Expand Down