Apache Airflow · API Governance Rules
Apache Airflow API Rules
Spectral linting rules defining API design standards and conventions for Apache Airflow.
24 Rules
error 8
warn 7
info 9
Rule Categories
dag
delete
get
info
microcks
no
openapi
operation
parameter
paths
response
schema
security
servers
Rules
error
info-title-required
Info title must be defined.
$.info
warn
info-description-required
Info description must be defined.
$.info
error
info-version-required
Info version must be defined.
$.info
error
openapi-version-3
OpenAPI version must be 3.x.
$
error
servers-defined
Servers must be defined.
$
info
paths-api-v2-prefix
Stable API paths should start with /api/v2/.
$.paths[*]~
info
paths-kebab-case
Path segments should use snake_case or kebab-case.
$.paths[*]~
error
operation-summary-required
Every operation must have a summary.
$.paths[*][get,post,put,patch,delete]
warn
operation-description-required
Every operation should have a description.
$.paths[*][get,post,put,patch,delete]
error
operation-operationId-required
Every operation must have an operationId.
$.paths[*][get,post,put,patch,delete]
warn
operation-tags-required
Every operation must have at least one tag.
$.paths[*][get,post,put,patch,delete]
info
operation-summary-starts-with-airflow
Operation summaries should start with "Airflow".
$.paths[*][get,post,put,patch,delete].summary
warn
parameter-description-required
All parameters should have a description.
$.paths[*][get,post,put,patch,delete].parameters[*]
error
response-success-required
Every operation must have at least one success response.
$.paths[*][get,post,put,patch,delete].responses
warn
response-description-required
All responses must have a description.
$.paths[*][get,post,put,patch,delete].responses[*]
info
response-401-documented
Operations should document 401 Unauthorized responses.
$.paths[*][get,post,put,patch,delete].responses
info
schema-description-recommended
Top-level schemas should have a description.
$.components.schemas[*]
info
schema-properties-snake-case
Schema property names should use snake_case.
$.components.schemas[*].properties[*]~
warn
security-schemes-defined
Security schemes should be defined.
$.components
error
get-no-request-body
GET operations should not have a request body.
$.paths[*].get
info
delete-returns-204
DELETE operations should return 204 No Content.
$.paths[*].delete.responses
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description
info
microcks-operation-extension
Operations should include x-microcks-operation for mock compatibility.
$.paths[*][get,post,put,patch,delete]
info
dag-resource-required
DAG endpoints are core to Airflow — they must be documented.
$.paths