You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It's helpful to know when a format value falls outside the supported set.
Describe the solution you'd like
Here are some rules we've been using locally:
oas3-integer-format:
description: Must use an official integer formatdocumentationUrl: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#data-typesgiven: $..properties[?(@.type == 'integer')]severity: errorthen:
field: formatfunction: enumerationfunctionOptions:
values:
- int32
- int64oas3-number-format:
description: Must use an official number formatdocumentationUrl: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#data-typesgiven: $..properties[?(@.type == 'number')]severity: errorthen:
field: formatfunction: enumerationfunctionOptions:
values:
- float
- doubleoas3-string-format:
description: Must use an official string formatdocumentationUrl: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#data-typesgiven: $..properties[?(@.type == 'string')]severity: errorthen:
field: formatfunction: enumerationfunctionOptions:
values:
- byte
- binary
- date
- date-time
- password
enhancementNew feature or requestOpenAPIIssues related to the OpenAPI ruleset
1 participant
Converted from issue
This discussion was converted from issue #1701 on March 23, 2023 16:06.
Heading
Bold
Italic
Quote
Code
Link
Numbered list
Unordered list
Task list
Attach files
Mention
Reference
Menu
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
User story.
As a spec author, I would like to know when a
format
value isn't officially supported by OAS.Is your feature request related to a problem?
OAS3 defines a specific set of
format
values for eachtype
: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#data-typesIt's helpful to know when a
format
value falls outside the supported set.Describe the solution you'd like
Here are some rules we've been using locally:
Beta Was this translation helpful? Give feedback.
All reactions