Skip to content

Update Rule 10 in papiNet-JSON-Style-Guide.md #313

Description

@larsolofsson

See also issue #311

Current rule 10

Rule 10 - Properties with ...Timestamp and ...DateTime suffixes

We have two types of properties capturing date and time:

  • The properties ending with the suffix ...Timestamp: the MUST contain a date and time expressed in UTC, ending with the letter "Z", e.g. 2024-04-23T13:24:26.000Z.
  • The properties ending with the suffix ...DateTime: they MUST contain a local date and time, in accordance with the ISO 8601 standard (preferably without explicit time-zone) for which the location is defined by the business context, excluding duration alone, but including intervals such as the following:
    • 2023-08-16T13:00/2023-08-18T13:00
    • 2023-08-16/2023-08-18
    • 2023-08-16T13:00/P2D
    • P2D/2023-08-18T13:00

Proposed change of rule 10

Rule 10 - Properties with ...Timestamp and ...DateTime suffixes

We have two types of properties capturing date and time:

  • The properties ending with the suffix ...Timestamp: the MUST contain a date and time expressed in UTC, ending with the letter "Z", e.g. 2024-04-23T13:24:26.000Z.
  • The properties having prefix actual and ending suffix DateTime actual...DateTime: they MUST contain a local date and time, in accordance with the ISO 8601 standard (preferably without explicit time-zone) for which the location is defined by the business context, excluding duration and intervals,, e.g. 2024-04-23T13:24:26
  • The properties ending with the suffix ...DateTime but NOT having prefix actual: they MUST contain a local date and time, in accordance with the ISO 8601 standard (preferably without explicit time-zone) for which the location is defined by the business context, excluding duration alone, but including intervals such as the following:
    • 2023-08-16T13:00/2023-08-18T13:00
    • 2023-08-16/2023-08-18
    • 2023-08-16T13:00/P2D
    • P2D/2023-08-18T13:00

Metadata

Metadata

Assignees

No one assigned

    Labels

    MUST BE DISCUSSEDMust be discussed during the next CWG meeting

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions