Skip to content

Commit f2ee7a3

Browse files
author
Phil Sturgeon
committed
The "Common Name" field was confusing people
So many people were considering dateTime, etc to be an OpenAPI type that tool vendors were implementing functionality to normalize this. mikunn/openapi-schema-to-json-schema#4 I too in the past have thought I was meant to use dateTime in the format, not date-time. Let's just get rid of this column, it serves no real purpose as far as I can tell.
1 parent 2d53f8d commit f2ee7a3

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

versions/3.0.2.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -151,19 +151,22 @@ Types that are not accompanied by a `format` property follow the type definition
151151

152152
The formats defined by the OAS are:
153153

154-
Common Name | [`type`](#dataTypes) | [`format`](#dataTypeFormat) | Comments
155-
----------- | ------ | -------- | --------
156-
integer | `integer` | `int32` | signed 32 bits
157-
long | `integer` | `int64` | signed 64 bits
158-
float | `number` | `float` | |
159-
double | `number` | `double` | |
160-
string | `string` | | |
161-
byte | `string` | `byte` | base64 encoded characters
162-
binary | `string` | `binary` | any sequence of octets
163-
boolean | `boolean` | | |
164-
date | `string` | `date` | As defined by `full-date` - [RFC3339](https://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14)
165-
dateTime | `string` | `date-time` | As defined by `date-time` - [RFC3339](https://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14)
166-
password | `string` | `password` | A hint to UIs to obscure input.
154+
[`type`](#dataTypes) | [`format`](#dataTypeFormat) | Comments
155+
------ | -------- | --------
156+
`integer` | `int32` | signed 32 bits
157+
`integer` | `int64` | signed 64 bits (a.k.a long)
158+
`number` | `float` | |
159+
`number` | `double` | |
160+
`string` | | |
161+
`string` | `byte` | base64 encoded characters
162+
`string` | `binary` | any sequence of octets
163+
`boolean` | | |
164+
`string` | `date` | As defined by `full-date` -
165+
[RFC3339](https://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14)
166+
`string` | `date-time` | As defined by `date-time` -
167+
[RFC3339](https://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14)
168+
`string` | `password` | A hint to UIs to obscure input.
169+
167170

168171
### <a name="richText"></a>Rich Text Formatting
169172
Throughout the specification `description` fields are noted as supporting CommonMark markdown formatting.

0 commit comments

Comments
 (0)