Acronis · API Governance Rules
Acronis API Rules
Spectral linting rules defining API design standards and conventions for Acronis.
33 Rules
error 15
warn 11
info 7
Rule Categories
delete
get
info
no
openapi
operation
parameter
paths
response
schema
security
servers
tags
tenant
Rules
error
info-title-required
OpenAPI info.title must be present
$.info
warn
info-description-required
OpenAPI info.description must be present
$.info
error
info-version-required
OpenAPI info.version must be defined
$.info
warn
info-contact-required
API info should include contact information
$.info
error
openapi-version-3x
Acronis APIs must use OpenAPI 3.x
$
error
servers-required
At least one server must be defined
$
error
servers-https
Server URLs must use HTTPS
$.servers[*]
info
servers-acronis-domain
Acronis API servers should use acronis.com domain
$.servers[*]
error
paths-no-trailing-slash
Paths must not end with a trailing slash
$.paths[*]~
error
operation-summary-required
All operations must have a summary
$.paths[*][get,post,put,patch,delete]
warn
operation-description-required
All operations should have a description
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
All operations must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
operation-id-camel-case
operationId should use camelCase
$.paths[*][get,post,put,patch,delete].operationId
error
operation-tags-required
All operations must have at least one tag
$.paths[*][get,post,put,patch,delete]
info
operation-summary-acronis-prefix
Operation summaries should start with 'Acronis'
$.paths[*][get,post,put,patch,delete].summary
info
operation-microcks-extension
Operations should have x-microcks-operation for mock testing
$.paths[*][get,post,put,patch,delete]
warn
tags-global-defined
Global tags array should be defined
$
warn
tags-description-required
All global tags should have descriptions
$.tags[*]
warn
parameter-description-required
All parameters should 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[*]
error
response-success-required
All operations must define at least one 2xx response
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
All responses must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
warn
response-401-required
Protected endpoints should define 401 responses
$.paths[*][get,post,put,patch,delete].responses
warn
schema-description-required
Top-level schemas should have descriptions
$.components.schemas[*]
warn
schema-type-required
Schema properties should define types
$.components.schemas[*].properties[*]
info
schema-property-description
Schema properties should have descriptions
$.components.schemas[*].properties[*]
info
schema-property-example
Schema properties should have examples
$.components.schemas[*].properties[*]
error
security-schemes-defined
Security schemes must be defined
$
info
security-bearer-scheme
Acronis APIs use bearer token authentication
$.components.securitySchemes[*]
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
warn
delete-returns-204
DELETE operations should return 204 No Content
$.paths[*].delete.responses
info
tenant-id-parameter
Endpoints that scope to a tenant should include tenant_id parameter
$.paths[*][get]
error
no-empty-descriptions
Descriptions must not be empty
$..description