Airtable · API Governance Rules
Airtable API Rules
Spectral linting rules defining API design standards and conventions for Airtable.
29 Rules
error 9
warn 9
info 11
Rule Categories
airtable
get
info
microcks
no
openapi
operation
parameter
paths
post
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.
$
warn
servers-https
Server URLs must use HTTPS.
$.servers[*]
info
servers-api-airtable-base
Airtable API servers should use api.airtable.com.
$.servers[*]
info
paths-v0-prefix
Airtable API paths typically start with /v0/.
$.paths[*]~
info
paths-kebab-or-base-id
Path segments should use kebab-case or base IDs.
$.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-airtable
Operation summaries should start with "Airtable".
$.paths[*][get,post,put,patch,delete].summary
warn
parameter-description-required
All parameters must have a description.
$.paths[*][get,post,put,patch,delete].parameters[*]
info
parameter-authorization-header
Authorization should use Bearer token scheme.
$.components.securitySchemes[*]
error
response-success-required
Every operation must have a 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-422-for-validation
Operations with request bodies should document 422 validation errors.
$.paths[*][post,put,patch].responses
info
schema-property-camelCase
Schema properties in Airtable APIs use camelCase.
$.components.schemas[*].properties[*]~
info
schema-description-required
Top-level schemas should have a description.
$.components.schemas[*]
error
security-schemes-defined
Security schemes must be defined.
$.components
warn
security-bearer-required
Airtable APIs use Bearer token authentication.
$.components.securitySchemes[*]
error
get-no-request-body
GET operations must not have a request body.
$.paths[*].get
info
post-list-uses-offset
List operations should support cursor or offset pagination.
$.paths[*].get
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
airtable-rate-limit-documented
Rate limits should be documented in the API info.
$.info