Search docs
Docs searchValidation rule
Back to Rule CatalogAP-API-001APIOpenAPI contract exists
Checks that an OpenAPI contract is present for REST API review.
errorsetup-gapNo auto-fix
How to fix
- Generate or restore the OpenAPI contract.
- Update the configured contract path if the file moved.
- Commit the contract or generated artifact according to your team workflow.
What the rule validates
ArchPilot expected an OpenAPI contract but could not find the configured contract artifact.
Why it matters
API contracts let teams review external behavior and catch API drift before consumers are surprised.
Common causes
- The OpenAPI file was never generated.
- The contract path changed.
- The API is REST-based but contract generation is not wired into the repo.
Typical violation example
REST controllers exist but contracts/openapi.yaml is missing.Typical compliant example
contracts/openapi.yaml is generated and reviewed with API changes.Related rules
Adjacent categories
Related files/config
contracts/openapi.yaml.archpilot/architecture.json
Related CLI commands
archpilot validatearchpilot validate --ci