Skip to content

[API-04] Complete canonical AsyncAPI event and webhook schema set #7

Description

@jaavid

Background

CoreLink is managed as one product across multiple implementation repositories. This work is the executable feature owned by api-contracts under EPIC-04.

Problem

The current repository state does not yet provide verified, release-ready evidence to complete canonical AsyncAPI event and webhook schema set.

Goal

Complete canonical AsyncAPI event and webhook schema set with observable acceptance evidence and no divergence from the product-level contract.

Parent

  • Primary Product Epic: EPIC-04
  • Backlog ID: API-04

Scope

  • Deliver the outcome stated in the title within the api-contracts implementation boundary.
  • Reconcile affected contracts, tests, documentation, security, tenancy, observability, migration and release behavior.
  • Retain acceptance evidence suitable for the Developer Platform product gate.

Out of Scope

  • Creating a separate repository roadmap.
  • Expanding into adjacent product domains without an accepted Product Epic or decision record.
  • Claiming completion based only on code merge when operational or customer validation is required.

Acceptance Criteria

  • The stated outcome is implemented or documented at the correct repository boundary.
  • Expected, failure and recovery paths are covered by repeatable checks or retained evidence.
  • Tenant isolation, authorization and sensitive-data behavior are reviewed where applicable.
  • Public/internal contract and compatibility impacts are reconciled.
  • Documentation, observability, migration/rollback and release notes are updated where applicable.
  • Evidence is attached or linked and the parent Epic exit criteria are measurably advanced.

Technical Notes

Preserve canonical identifiers, provider-neutral public behavior, idempotency and backward compatibility. Prefer the existing modular-monolith boundary unless measured scale, security isolation or ownership requires extraction.

Dependencies

  • Prerequisite completed: API-01 established the initial public contract baseline.
  • Active blockers: PLAT-05 and PLAT-06.
  • Blocks: Canonical event/webhook schema readiness and downstream SDK/documentation parity for the Developer Platform gate.
  • Cross-repository work: Link concrete Issues during refinement; do not duplicate their implementation here.
  • Current dependency state: See the CoreLink Product organization Project.

Planning Metadata

  • Type: Feature
  • Priority: P0
  • Product milestone: Developer Platform
  • Domains: api, telemetry
  • Area: contract
  • Complexity: L
  • Created in status: Triage
  • Current status and DRI: See the CoreLink Product organization Project.
  • Intended repository labels: type:feature

Definition of Done

  • Acceptance criteria demonstrated.
  • Required tests and evidence pass.
  • Contracts are updated or confirmed unaffected.
  • Security and tenant boundaries are reviewed.
  • Migration and rollback paths are verified where applicable.
  • Observability and runbooks are updated where applicable.
  • Documentation and release notes are updated.
  • Pull request(s) are merged and linked.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    type:featureUser-visible product capability or outcome

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions