Skip to content

TASK: Validate versioned AsyncAPI contracts in CI #235

Closed

Description

@ramioooz

Parent\n\n- Parent Story: #61\n- Parent Epic: #30\n- Sprint: Sprint 3 - Internal Transfers and Event Consistency\n\n## Objective\n\nValidate the governed AsyncAPI event contracts whenever contract files change.\n\n## Scope\n\n- Validate every docs/contracts/*-asyncapi.yml document with the standard Ruby YAML parser.\n- Check AsyncAPI metadata, Kafka channels/operations, message references, component schemas, required event metadata, and declared Schema Registry compatibility.\n- Resolve local JSON/YAML references and fail on missing targets.\n- Run only when the contract files or validator change.\n\n## Definition of Done\n\n- Pull requests changing event contracts receive one focused validation check.\n- Invalid or incomplete contract metadata fails before merge.\n- Existing service CI remains unchanged and no runtime Schema Registry credentials are added.\n- The validator and workflow are documented for contributors.\n\n## Boundaries\n\nThis task does not deploy Schema Registry, generate Java models, change Kafka topics, or add a second service CI workflow.

Activity

  1. added theissue type on Sep 5, 2026
  2. self-assigned this
    on Sep 5, 2026
  3. ramioooz commented on Sep 5, 2026

    @ramioooz
    MemberAuthor

    Implementation PR: https://github.com/digital-bank-java/.github/pull/236\n\nValidation passed locally for all four AsyncAPI documents. The single path-scoped workflow checks metadata, Kafka channel/operation wiring, local references, required event/header metadata, and BACKWARD_TRANSITIVE registry declarations. No service CI, runtime registry credentials, or duplicate tests were added.

  4. ramioooz commented on Sep 5, 2026

    @ramioooz
    MemberAuthor

    PR #237 extends this CI task on top of #236 by validating every representative AsyncAPI payload example against its declared schema. It adds no workflow/job and uses no external dependency. PR #237 CI passed; merge #236 first, then #237.

  5. ramioooz commented on Sep 5, 2026

    @ramioooz
    MemberAuthor

    Both validation PRs are merged: #236 and #237. The single focused AsyncAPI CI validation path and representative payload checks are complete. Runtime Schema Registry deployment and producer/consumer adoption remain outside this task scope.

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

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions