Apify · API Governance Rules
Apify API Rules
Spectral linting rules defining API design standards and conventions for Apify.
11 Rules
error 4
warn 5
info 2
Rule Categories
info
operation
pagination
parameter
paths
response
servers
Rules
warn
info-title-prefix
API title must start with 'Apify'.
$.info
error
info-description-required
API must have a description.
$.info
error
servers-https
All server URLs must use HTTPS.
$.servers[*]
warn
operation-summary-prefix
Operation summaries must start with 'Apify'.
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
Every operation must have an operationId.
$.paths[*][get,post,put,patch,delete]
warn
operation-id-camelcase
OperationId must use camelCase.
$.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
paths-v2-version
Paths must include API version /v2/ prefix.
$.paths
error
response-success-required
Every operation must have a 2xx response.
$.paths[*][get,post,put,patch,delete].responses
warn
parameter-description-required
All parameters must have a description.
$.paths[*][get,post,put,patch,delete].parameters[*]
info
pagination-limit-offset
Collection endpoints should use limit/offset pagination.
$.paths[*].get.parameters[*]