Amazon Certificate Manager · API Governance Rules
Amazon Certificate Manager API Rules
Spectral linting rules defining API design standards and conventions for Amazon Certificate Manager.
29 Rules
error 15
warn 11
info 3
Rule Categories
delete
external
get
info
microcks
no
openapi
operation
parameter
request
response
schema
security
servers
Rules
error
info-title-prefix
API title must start with "Amazon Certificate Manager"
$.info.title
error
info-description-required
Info object must have a description
$.info
error
info-version-required
API must have a version
$.info
warn
info-contact-required
API must have contact information
$.info
error
openapi-version
Must use OpenAPI 3.x
$
error
servers-required
API must define at least one server
$
error
servers-https-only
All server URLs must use HTTPS
$.servers[*].url
warn
servers-description-required
All servers must have a description
$.servers[*]
error
operation-operationId-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-operationId-pascal-case
operationId must use PascalCase (matches AWS convention)
$.paths[*][get,post,put,patch,delete,head,options].operationId
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-summary-prefix
Operation summaries must start with "Amazon Certificate Manager"
$.paths[*][get,post,put,patch,delete,head,options].summary
error
operation-description-required
Every operation must have a description
$.paths[*][get,post,put,patch,delete,head,options]
error
operation-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete,head,options]
warn
parameter-description-required
All parameters must have descriptions
$.paths[*][get,post,put,patch,delete].parameters[*]
error
parameter-schema-required
All parameters must have a schema
$.paths[*][get,post,put,patch,delete].parameters[*]
warn
request-body-json-content
Request bodies should use application/json content type
$.paths[*][post,put,patch].requestBody.content
error
response-success-required
Every operation must have a 2xx success response
$.paths[*][get,post,put,patch,delete]
error
response-description-required
All response codes must have descriptions
$.paths[*][get,post,put,patch,delete].responses[*]
warn
response-401-for-secured
Operations should include 400 bad request response
$.paths[*][post,put,patch,delete].responses
info
response-500-required
Operations should document 500 internal server error
$.paths[*][get,post,put,patch,delete].responses
warn
schema-description-on-top-level
Top-level component schemas should have descriptions
$.components.schemas[*]
warn
schema-properties-have-types
Schema properties must define a type
$.components.schemas[*].properties[*]
warn
security-schemes-defined
Security schemes must be defined if security is referenced
$.components
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
error
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
external-docs-encouraged
APIs should have external documentation links
$
info
microcks-operation-present
Operations should have x-microcks-operation extension for mock server support
$.paths[*][get,post,put,patch,delete]