The short answer is “not implicitly”. 

 

The longer version – the current available formats are the ones defined by JSON 
Schema and a few additional ones.

Starting OAS3 we’re introducing a new concenpt of a format registry, where 
users could propose and register new formats that would be considered a 
standard in the OpenAPI.

This is still an early stage and we don’t have the official process yet.

 

Keep in mind that format is technically a free-form field and anything can be 
used in it. The issue is with translating it by the tools.

 

 

 

From: <[email protected]> on behalf of Julien Silland 
<[email protected]>
Reply-To: "[email protected]" 
<[email protected]>
Date: Wednesday, November 1, 2017 at 13:14
To: Swagger <[email protected]>
Subject: Support for datetimes without timezones

 

Hello all,

 

My team is in the process of retrofitting a Swagger/OpenAPI specification onto 
a relatively large API. One of the peculiarities of a given endpoint is that it 
accepts and returns a model containing datetimes but without the timezone, 
which is inferred on the server side using a location sent as a lat/lng in the 
same model: 

 

{

  start_time: "2017-10-31T07:30:00"

  start_location: [-34, 151]

}

 

The Swagger spec relies on RFC3339 
https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14, which 
mandates the presence of a timezone component. What we actually need here is a 
time date where the timezone is absent, as the server will opt to fail if that 
is present in the date. 

 

Is there any support or planned support for "local" time dates as we need them? 
While we can certainly define a `pattern` for that field, I don't believe that 
they are broadly supported in the generated clients, and the developer 
experience of using a string as opposed to a specialized object is subpar.

 

Cheers,

-j

-- 
You received this message because you are subscribed to the Google Groups 
"Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
For more options, visit https://groups.google.com/d/optout.


-- 
You received this message because you are subscribed to the Google Groups 
"Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
For more options, visit https://groups.google.com/d/optout.

Reply via email to