Has Docs
api-docs.has-docs
Checks that all API spec files include human-readable documentation
(descriptions, examples) by verifying .api.spec_files[].has_docs is
true for every entry. A bare definition without descriptions doesn't
count. Skips if no spec files were detected.
Compatible Integrations
This guardrail works with the following integrations. Click to see how to use Has Docs 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: [has-docs]
# 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