Albato A Single No Code Platform For All Automations · API Governance Rules
Albato A Single No Code Platform For All Automations API Rules
Spectral linting rules defining API design standards and conventions for Albato A Single No Code Platform For All Automations.
25 Rules
error 15
warn 10
Rule Categories
albato
Rules
error
albato-auth-apikey-required
Albato APIs must define API key authentication
$.components.securitySchemes
error
albato-global-security-defined
Global security must be defined
$.security[*]
error
albato-info-title
API title must be present
$.info
error
albato-info-description
API description must be present
$.info
error
albato-info-version
API version must be present
$.info
warn
albato-path-no-trailing-slash
Paths must not end with a trailing slash
$.paths
error
albato-path-lowercase
Paths must be lowercase with hyphens
$.paths
error
albato-operation-id-required
All operations must have an operationId
$.paths[*][get,post,put,patch,delete]
error
albato-operation-summary-required
All operations must have a summary
$.paths[*][get,post,put,patch,delete]
warn
albato-operation-description-required
All operations should have a description
$.paths[*][get,post,put,patch,delete]
error
albato-operation-tags-required
All operations must have tags
$.paths[*][get,post,put,patch,delete]
error
albato-response-200-get
GET operations must define a 200 response
$.paths[*].get.responses
warn
albato-response-201-post
POST create operations should return 201
$.paths[*].post.responses
warn
albato-response-401
Operations should document 401 Unauthorized
$.paths[*].get.responses
error
albato-response-json
Responses must use application/json
$.paths[*][get,post,put].responses[200,201].content
warn
albato-schema-description
Schemas must have descriptions
$.components.schemas[*]
error
albato-property-type
Schema properties must have types
$.components.schemas[*].properties[*]
warn
albato-parameter-description
Parameters should have descriptions
$.paths[*][*].parameters[*]
error
albato-path-param-schema
Path parameters must have schemas
$.paths[*][*].parameters[?(@.in=='path')]
warn
albato-operation-id-camel-case
operationId must use camelCase
$.paths[*][*].operationId
warn
albato-schema-pascal-case
Schema names must use PascalCase
$.components.schemas
error
albato-request-body-json
Request bodies must use application/json
$.paths[*][post,put,patch].requestBody.content
warn
albato-request-body-required
POST operations should have required request bodies
$.paths[*].post.requestBody
error
albato-servers-defined
API must define servers
$
warn
albato-tags-documented
Tags must be documented at root level
$