Skip to content

Support for alternative gts.<type>.<instance_id> pattern notation #54

Description

@Artifizer

The system must support an alternative notation for identifiers in the following format.

Current notation

Schema:

{
   ...
  "properties": {
    "id": {
      "description": "UUID identifier of the event instance",
      "type": "string",
      "format": "uuid"
    },
    "type": {
      "description": "GTS type identifier for ...",
      "type": "string",
      "x-gts-ref": "..."
    },
    "occurredAt": {
      "description": "Event timestamp in RFC3339 format",
      "type": "string",
      "format": "date-time"
    }
  }
}
{
  "id": "7a1d2f34-5678-49ab-9012-abcdef123456",
  "type": "gts.x.core.events.type.v1~x.commerce.orders.order_placed.v1.0~",
  "occurredAt": "2025-09-20T18:35:00Z"
}```

**Alternative notation**

Some services (via GET or POST endpoints) must also support the combined identifier format:
`gts.<segment1>~<segment2>~<UUID>`

Using this format, the example above becomes:

Instance:

{
"id": "gts.x.core.events.type.v1x.commerce.orders.order_placed.v1.07a1d2f34-5678-49ab-9012-abcdef123456",
"occurredAt": "2025-09-20T18:35:00Z"
}```

schema:

{
  ...
  "properties": {
    "id": {
      "description": "GTS instance identifier including the type and instance UUID",
      "type": "string",
      "x-gts-ref": "..."
    },
    "occurredAt": {
      "description": "Event timestamp in RFC3339 format",
      "type": "string",
      "format": "date-time"
    }
  }
}

Definition of done

Phase #1:

Phase #2

  • Update gts-web
  • Update gts-kit

Phase #3:

  • Update gts-python
  • Update gts-go
  • Update gts-ts

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions