Spec Version
openapi.spec-version
Ensures all REST API specs meet a minimum OpenAPI version. Compares the
major version from .api.spec_files[].version against min_version
(default: 3). Flags any spec below the threshold. Only checks entries
with protocol: "rest". Skips if no REST spec files were detected.
Compatible Integrations
This guardrail works with the following integrations. Click to see how to use Spec Version 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/openapi@v1.0.0
include: [spec-version]
# with: ...
How This Guardrail Works
This guardrail is part of the OpenAPI 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 |
|---|---|---|---|
min_version
|
Optional |
3
|
Minimum required major OpenAPI version. Specs with a major version below this value will fail. Default is 3 (i.e., require OpenAPI 3.x+). |
OpenAPI Guardrails
This guardrail is part of the OpenAPI Guardrails policy, which includes 1 guardrail for devex build and ci.
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.