Amazon DevOps Guru · API Governance Rules
Amazon DevOps Guru API Rules
Spectral linting rules defining API design standards and conventions for Amazon DevOps Guru.
17 Rules
error 11
warn 4
info 2
Rule Categories
external
get
info
no
openapi
operation
parameter
response
schema
servers
Rules
warn
info-title-prefix
API title should include "DevOps Guru"
$.info.title
error
info-description-required
API must have a description
$.info
error
info-version-required
API must have a version
$.info
error
openapi-version-3
Must use OpenAPI 3.x
$
error
servers-defined
At least one server must be defined
$
error
servers-https-only
All server URLs must use HTTPS
$.servers[*].url
error
operation-summary-required
All operations must have a summary
$.paths[*][get,post,put,delete,patch]
warn
operation-description-required
All operations must have a description
$.paths[*][get,post,put,delete,patch]
error
operation-id-required
All operations must have an operationId
$.paths[*][get,post,put,delete,patch]
warn
operation-tags-required
All operations must have at least one tag
$.paths[*][get,post,put,delete,patch]
warn
parameter-description-required
All parameters must have a description
$.paths[*][get,post,put,delete,patch].parameters[*]
error
response-success-required
Operations must have at least one 2xx response
$.paths[*][get,post,put,delete,patch].responses
error
response-description-required
All responses must have a description
$.paths[*][get,post,put,delete,patch].responses[*]
info
schema-description-required
Top-level schemas should have descriptions
$.components.schemas[*]
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
error
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
external-docs-encouraged
API should reference external documentation
$