Skip to content

fix(docs): Incorrect Timestamp range and terminology in generated OpenAPI specs #3264

@marythought

Description

@marythought

The generated OpenAPI specs for authorization (and likely other services) have two issues in their google.protobuf.Timestamp field descriptions:

1. Wrong numeric range for seconds

The spec says:

Must be between -315576000000 and 315576000000 inclusive

This is the range for google.protobuf.Duration (~10,000 years). The correct range for Timestamp (0001-01-01 to 9999-12-31) is -62135596800 to 253402300799.

2. "duration" terminology in nanos description

The nanos field is described as "the nanosecond portion of the duration" — should say "timestamp."

Affected file(s):

  • docs/openapi/authorization/authorization.openapi.yaml (lines ~97, 107, 112+)
  • Likely appears in other generated specs as well

These descriptions come from protobuf's well-known type definitions and are generated by the OpenAPI toolchain (buf/protoc-gen-openapiv2), so the fix may need to happen at the generation layer or as a post-processing step.

Found during review of opentdf/docs#278.

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