Skip to content

Documentation Request for Date Handling and Key Naming Conventions #295

@apricot13

Description

@apricot13

Could we have some documentation detailing the conventions for date handling and key naming?

We already have Date and DateTime types but it would be helpful to have a clear description of:

  • The format for date-only values (e.g., YYYY-MM-DD).
  • The use of ISO 8601 with UTC for datetime values.
  • A naming convention to include Date in fields representing dates and At in fields representing datetime values for quick distinction.
interface Example {
  receivedDate: string; // Date-only (YYYY-MM-DD)
  createdAt: string;    // Datetime (ISO 8601 with UTC, e.g., 2024-01-01T10:30:00Z)
}

We've been using this naming convention between DPR and BOPs but we're having to normalise the dates to UTC currently.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions