Axon Shaft docs
Checklist catalog

HTTP and schema contracts

Breaking changes in OpenAPI, GraphQL or protobuf schemas.

  • Check run: Axon Shaft / api-contract
  • How it checks: A script built into the action gathers facts, and the model judges them.
  • Suits: Services and APIs
  • In templates: Strict review, Go or Rust service

What it looks for

  • Removed or renamed fields in OpenAPI, GraphQL or protobuf schemas
  • Changes that break existing clients
  • Breaking changes to a contract with no version

A finding might read: The status field was removed from GET /orders

Files it runs on

It runs only when a changed file matches one of these, and is skipped otherwise.

  • **/openapi.*
  • **/*.graphql
  • **/*.proto

Last updated on