AWS App Runner · API Governance Rules
AWS App Runner API Rules
Spectral linting rules defining API design standards and conventions for AWS App Runner.
17 Rules
error 12
warn 5
Rule Categories
info
method
no
openapi
operation
response
schema
security
servers
Rules
warn
info-title-prefix
API title must start with "AWS App Runner"
$.info.title
error
info-description-required
Info object must have a description
$.info
error
info-version-required
Info object must have a version
$.info
error
openapi-version-3
All specs must use OpenAPI 3.x
$
error
servers-defined
Servers array must be defined
$
error
servers-https
All server URLs must use HTTPS
$.servers[*].url
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 "AWS App Runner"
$.paths[*][get,post,put,patch,delete].summary
error
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
OperationIds should use PascalCase
$.paths[*][get,post,put,patch,delete].operationId
error
response-description-required
All responses must have descriptions
$.paths[*][*].responses[*]
error
response-success-required
Every operation must have at least one 2xx response
$.paths[*][get,post,put,patch,delete]
warn
schema-description
Component schemas should have descriptions
$.components.schemas[*]
warn
security-schemes-defined
Security schemes should be defined
$
error
method-get-no-body
GET operations must not have a request body
$.paths[*].get
error
no-empty-descriptions
Descriptions must not be empty
$..description