Skip to content

Mandatory text for format: date-time does not define notation of recommended pattern #498

@eric-murray

Description

@eric-murray

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-time string 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions