Acquia · API Governance Rules
Acquia API Rules
Spectral linting rules defining API design standards and conventions for Acquia.
32 Rules
error 14
warn 10
info 8
Rule Categories
actions
delete
get
hal
info
no
openapi
operation
parameter
paths
post
response
schema
security
servers
tags
Rules
error
info-title-required
OpenAPI info.title must be present and non-empty
$.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
Acquia 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-acquia-cloud-domain
Acquia Cloud API server should use cloud.acquia.com domain
$.servers[*]
error
paths-no-trailing-slash
Paths must not end with a trailing slash
$.paths[*]~
info
paths-uuid-format
Resource identifiers in paths should use UUID suffix pattern
$.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]
error
operation-tags-required
All operations must have at least one tag
$.paths[*][get,post,put,patch,delete]
info
operation-summary-acquia-prefix
Operation summaries should start with 'Acquia'
$.paths[*][get,post,put,patch,delete].summary
warn
tags-global-defined
Global tags array should be defined
$
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[*]
info
parameter-uuid-naming
UUID path parameters should end with 'Uuid' suffix
$.paths[*][get,post,put,patch,delete].parameters[?(@.in == 'path')]
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-unauthorized
Protected endpoints should define 401 Unauthorized responses
$.paths[*][get,post,put,patch,delete].responses
warn
response-403-forbidden
Protected endpoints should define 403 Forbidden responses
$.paths[*][post,put,patch,delete].responses
warn
schema-type-defined
Schema components should define a type
$.components.schemas[*]
error
security-schemes-defined
Security schemes must be defined in components
$
info
security-oauth2-scheme
Acquia Cloud API uses OAuth2 authentication
$.components.securitySchemes[*]
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
warn
delete-no-request-body
DELETE operations should not have a request body
$.paths[*].delete
info
post-has-request-body
POST operations creating resources should have a request body
$.paths[*].post
info
actions-paths-pattern
Action endpoints should follow /resources/{id}/actions/{action-name} pattern
$.paths[*~\/actions\/]~
info
hal-json-content-type
Acquia Cloud API responses use application/hal+json content type
$.paths[*][get,post,put,patch,delete].responses[*].content
warn
no-empty-descriptions
Descriptions must not be empty strings
$..description