Skip to content

Rename DateTimeDescriptor epochMillis and epochNanos #966

Closed
@cdavernas

Description

@cdavernas

What would you like to be added:

  • Rename DateTimeDescriptor epochMillis and epochNanos.
  • Move iso8601, epochMillis and epochNanos properties to a DateTimeDescriptor object, so we avoid duplication (in both WorkflowDescriptor and TaskDescriptor).
  • Move epochMillis and epochNanos to a new epoch DateTimeDescriptor property, for a cleaner aspect.

Why is this needed:

  • The properties use abbreviations, which should always be avoided, If we decide to abbreviate, we should use the standard format, and not an opiniated one (ms and ns).
  • Cleans up definitions
  • Increases maintainability
  • Increases readability

The proposal:

DateTime Descriptor

Name Type Description Example
iso8601 string The start time of the execution as a ISO 8601 date time string. It uses T as the date-time delimiter, either UTC (Z) or a time zone offset (+01:00). The precision can be either seconds, milliseconds or nanoseconds 2022-01-01T12:00:00Z, 2022-01-01T12:00:00.123456Z, 2022-01-01T12:00:00.123+01:00
epoch.ms integer The start time of the execution as a integer value of milliseconds since midnight of 1970-01-01 UTC 1641024000123 (="2022-01-01T08:00:00.123Z")
epoch.ns integer The start time of the execution as a integer value of nanoseconds since midnight of 1970-01-01 UTC 1641024000123456 (="2022-01-01T08:00:00.123456Z")

Metadata

Metadata

Labels

area: specChanges in the Specificationchange: breakingA breaking change that will impact in a major version change.change: documentationImprovements or additions to documentation. It won't impact a version change.change: fixSomething isn't working. Impacts in a minor version change.

Type

No type

Projects

Status

Done

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions