versions/2.0: Add a 'time' type #355
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wking
force-pushed
the
time-format
branch
3 times, most recently
from
44c1370 to
c3119d8
Compare
Having human-readable times that are not associated with dates is
frequently useful. For example, this lets you say things like:
* "tea is at 3:15pm" (localtime)
* "the weekly meeting is at 12:00 UTC"
Using the ISO 8061 time formats [1,2] should make it easy for both
people and software to interact with the values.
Since Swagger-specified APIs are often consumed and produced from
JavaScript, and since JavaScript has limited time-handling
capabilities, I thought I'd dig a bit deeper in that direction.
Support for date-less ISO 8601 times in native JavaScript is unclear
[3], but Firefox 31.5 in seems to support times with a 'T' prefix:
> new Date('12:34')
Invalid Date
> new Date('T12:34')
Date 1970-01-01T20:34:00.000Z
> new Date('T12:34Z')
Date 1970-01-01T12:34:00.000Z
which, in conjunction with Date.prototype.toTimeString() [4] and other
time-specific maniplations is probably sufficient for most purposes.
Chromium 41.0, on the other hand, gave 'Invalid Date' warnings for
each of those cases, so JavaScript consumers may want to pad their
times with dummy date information. Moment.js also requires a date
part and doesn't support stand-alone times [5].
On the other hand, there are time-only pickers in JavaScript [6].
Python also has a time-only format [7] as does Java [8,9]. Go just
has a date-time type, but it can parse time-only strings [10].
[1]: http://en.wikipedia.org/wiki/ISO_8601#Times
[2]: http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
[3]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse#Parameters
[4]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toTimeString
[5]: http://momentjs.com/docs/#supported-iso-8601-strings
[6]: https://angular-ui.github.io/bootstrap/#/timepicker
[7]: https://docs.python.org/3/library/datetime.html#time-objects
[8]: https://docs.oracle.com/javase/8/docs/api/java/time/OffsetTime.html
[9]: https://docs.oracle.com/javase/8/docs/api/java/time/LocalTime.html
[10]: http://golang.org/pkg/time/#Parse
|
Same comment applies as the previous PR... sorry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Having human-readable times that are not associated with dates is
frequently useful. For example, this lets you say things like:
Using the ISO 8061 time formats should make it easy for both
people and software to interact with the values.
Since Swagger-specified APIs are often consumed and produced from
JavaScript, and since JavaScript has limited time-handling
capabilities, I thought I'd dig a bit deeper in that direction.
Support for date-less ISO 8601 times in native JavaScript is unclear,
but Firefox 31.5 in seems to support times with a 'T' prefix:
which, in conjunction with Date.prototype.toTimeString() and other
time-specific maniplations is probably sufficient for most purposes.
Chromium 41.0, on the other hand, gave 'Invalid Date' warnings for
each of those cases, so JavaScript consumers may want to pad their
times with dummy date information. Moment.js also requires a date
part and doesn't support stand-alone times.
On the other hand, there are time-only pickers in JavaScript.
Python also has a time-only format as does Java. Go just
has a date-time type, but it can parse time-only strings.