Airbyte · API Governance Rules
Airbyte API Rules
Spectral linting rules defining API design standards and conventions for Airbyte.
28 Rules
error 9
warn 12
info 7
Rule Categories
delete
get
info
microcks
no
openapi
operation
parameter
paths
request
response
schema
security
servers
Rules
error
info-title-required
Info title must be defined.
$.info
warn
info-description-required
Info description must be defined and non-empty.
$.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 array must be defined.
$
warn
servers-https
Server URLs should use HTTPS.
$.servers[*]
warn
paths-kebab-case
Path segments should use kebab-case.
$.paths[*]~
warn
paths-no-trailing-slash
Paths must not have trailing slashes.
$.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-operationId-camelCase
operationId should use camelCase.
$.paths[*][get,post,put,patch,delete].operationId
warn
operation-tags-required
Every operation must have at least one tag.
$.paths[*][get,post,put,patch,delete]
info
operation-summary-starts-with-airbyte
Operation summaries should start with "Airbyte".
$.paths[*][get,post,put,patch,delete].summary
warn
parameter-description-required
All parameters must have a description.
$.paths[*][get,post,put,patch,delete].parameters[*]
error
parameter-schema-required
All parameters must have a schema.
$.paths[*][get,post,put,patch,delete].parameters[*]
info
request-body-json-content
Request bodies should use application/json content type.
$.paths[*][post,put,patch].requestBody.content
error
response-success-required
Every operation must have at least one 2xx 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-on-secured-ops
Secured operations should document 401 response.
$.paths[*][get,post,put,patch,delete].responses
info
schema-properties-snake-case
Schema property names should use snake_case.
$.components.schemas[*].properties[*]~
info
schema-description-required
Top-level schemas should have a description.
$.components.schemas[*]
warn
security-schemes-defined
Security schemes should be defined in components.
$.components
info
security-bearer-format
Bearer security should use bearerFormat JWT or similar.
$.components.securitySchemes[*][?(@.scheme == 'bearer')]
error
get-no-request-body
GET operations should not have a request body.
$.paths[*].get
warn
delete-no-request-body
DELETE operations should not have a request body.
$.paths[*].delete
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]