-
Notifications
You must be signed in to change notification settings - Fork 32
Mandatory text for format: date-time does not define notation of recommended pattern #498
Copy link
Copy link
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Problem description
The recommended formatting pattern within the mandatory text for format: date-time is yyyy-MM-dd'T'HH:mm:ss.SSSZ, but no reference is given to the definitions used for this notation. Instead, two examples complying with this recommended format are given, but documenting a notation solely through examples is bad practice.
Expected action
There are three possible solutions to this issue:
- Remove any reference to recommended formats, as any
date-timestring compliant with RFC 3339 is allowed by the standard; or - Explicitly reference the source of the recommended format notation, which is the Java DateTimeFormatter class; or
- Remove the recommended format definition, and only give the examples
Additional context
https://spec.openapis.org/registry/format/date-time.html
https://datatracker.ietf.org/doc/html/rfc3339
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation