Skip to content

CONTRACT.md

Latest commit

 

History

History
23 lines (17 loc) · 912 Bytes

CONTRACT.md

File metadata and controls

23 lines (17 loc) · 912 Bytes
Raw

Auth API Contract

client-spec/openapi/auth-api.json is the committed API contract for auth-api consumers.

The contract is produced by :api:exportOpenApiSpec, which runs only the JUnit contract-export tag. Regular integration tests exclude that tag so contract export does not start Postgres, Valkey, or RabbitMQ.

Regenerate the contract before changing controller request or response shapes:

./gradlew :api:exportOpenApiSpec --no-daemon
git diff -- client-spec/openapi/auth-api.json

Generated clients are published from the committed spec by the shared JorisJonkers-dev/github-workflows/.github/workflows/publish-api-clients.yml workflow. The client projects are generated in the workflow workspace and are not committed to this repository.

  • npm: @jorisjonkers-dev/auth-api-client
  • Maven: dev.jorisjonkers:auth-api-client-java
  • Maven: dev.jorisjonkers:auth-api-client-kotlin