Skip to content

Onboarding

Onboarding is the entry point of the lifecycle: a contract is read, parsed and validated for its format, scored against the design guidelines, and — if it passes — registered so it shows up in the Catalog.

Format Notes
OpenAPI 3.0.x and 3.1.x
AsyncAPI event-driven contracts
GraphQL SDL schema definition language
WSDL SOAP service descriptions
  1. Read — the contract is fetched and its format detected.
  2. Parse & validate — format-specific parsing; a document that will not parse stops here.
  3. Overlay — an optional OpenAPI Overlay is applied.
  4. Score — the contract is graded, producing a scorecard per dimension.
  5. Register — the result is persisted and becomes discoverable.