Spec Exists
api-docs.spec-exists
Verifies that at least one API specification file exists in the repository
by checking if .api.spec_files[] is non-empty. Protocol-agnostic — works
for REST (OpenAPI/Swagger), gRPC (protobuf), or any future API format.
Skips if neither the openapi nor swagger collector has run.
Compatible Integrations
This guardrail works with the following integrations. Click to see how to use Spec Exists with each collector.
Enable This Guardrail
Add the parent policy to your lunar-config.yml to enable this guardrail.
policies:
- uses: github://earthly/lunar-lib/policies/api-docs@v1.0.0
include: [spec-exists]
# with: ...How This Guardrail Works
This guardrail is part of the API Docs Guardrails policy. It evaluates data collected by integrations and produces a pass/fail check with actionable feedback.
When enabled, this check runs automatically on every PR and in AI coding workflows, providing real-time enforcement of your engineering standards.
Learn How Lunar Works →Configuration Options
These inputs can be configured in your lunar-config.yml to customize
how the parent policy (and this guardrail) behaves.
| Input | Required | Default | Description |
|---|
API Docs Guardrails
This guardrail is part of the API Docs Guardrails policy, which includes 3 guardrails for repository and ownership.
Ready to Automate Your Standards?
See how Lunar can turn your engineering wiki, compliance docs, or postmortem action items into automated guardrails with our 100+ built-in guardrails.
Infrastructure conventions
Post-mortem action items
Security & compliance policies
Testing & quality requirements