Amazon Service Catalog · API Governance Rules
Amazon Service Catalog API Rules
Spectral linting rules defining API design standards and conventions for Amazon Service Catalog.
20 Rules
error 9
warn 9
info 2
Rule Categories
get
global
info
microcks
openapi
operation
parameter
response
schema
security
servers
Rules
error
info-title-required
Info title must be present
$.info
warn
info-description-required
Info description must be present
$.info
error
info-version-required
Info version must be present
$.info
error
openapi-version-3
Must use OpenAPI 3.x
$
error
servers-required
Servers must be defined
$
error
servers-https-only
Server URLs must use HTTPS
$.servers[*]
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-prefix
Operation summaries must start with "Amazon Service Catalog"
$.paths[*][get,post,put,patch,delete].summary
warn
operation-description-required
Every operation must have a description
$.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-pascal-case
operationId must use PascalCase (Service Catalog convention)
$.paths[*][get,post,put,patch,delete].operationId
warn
operation-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete]
warn
parameter-description-required
Every parameter must have a description
$.paths[*][get,post,put,patch,delete].parameters[*]
error
response-success-required
Every operation must have a success response
$.paths[*][get,post,put,patch,delete].responses
warn
response-description-required
Every response must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
info
schema-description-recommended
Top-level component schemas should have descriptions
$.components.schemas[*]
warn
security-schemes-defined
Security schemes should be defined in components
$
warn
global-security-defined
Global security should be defined
$
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
info
microcks-operation-present
Operations should have x-microcks-operation for mock support
$.paths[*][get,post,put,patch,delete]