kata-events-doc

To document CloudEvents with consistent idempotency, generate a canonical events.md file cataloging event types, required CloudEvents fields, and entity-based data payloads. This ensures every event documents an idempotencykey so consumers can reliably deduplicate messages.

Required CloudEvents documentation fields include type, source, subject, idempotencykey, and data. The documentation must define these fields for each event entry alongside properly structured JSON examples to satisfy lex-cloudevents and codex-cloudevents compliance.

To generate event documentation for lifecycle transitions, create or update docs/{context}/events/events.md using existing entity definitions. The process catalogs domain events like created, updated, and cancelled, aligning data payloads with codex-entities field definitions while omitting history.

Yes, CloudEvents entity payloads must adhere to strict JSON constraints keeping the payload size under 12KB. The documentation enforces these size limitations alongside idempotencykey requirements to ensure compliant event specifications for downstream integration.

Yes, you can use existing entity definitions under docs/{context}/entities to structure CloudEvents data payloads. The documentation aligns each event's data payload with codex-entities field definitions, automatically omitting history fields as required by the specification.

You need to update events.md when a bounded context module emits one or more domain events with lifecycle transitions. This ensures downstream teams can integrate without ambiguity by maintaining strict type, source, subject, and idempotencykey conventions.