Amazon App Runner · API Governance Rules
Amazon App Runner API Rules
Spectral linting rules defining API design standards and conventions for Amazon App Runner.
11 Rules
error 3
warn 8
Rule Categories
amazon
error
no
operationid
query
schema
security
servers
Rules
error
amazon-app-runner-info-title
API must have a title.
$.info
error
amazon-app-runner-operation-summary
Operations must have summaries.
$.paths[*][get,post,put,patch,delete]
error
amazon-app-runner-operation-id
Operations must have operationIds.
$.paths[*][get,post,put,patch,delete]
warn
servers-https-only
Server URLs must use HTTPS.
$.servers[*].url
warn
query-params-casing
Query parameters should be PascalCase (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
warn
operationid-casing
Operation IDs should be PascalCase (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].operationId
warn
schema-names-casing
Component schema names should be PascalCase (the dominant convention in this API).
$.components.schemas
warn
schema-properties-casing
Schema properties should be PascalCase (the dominant convention in this API).
$.components.schemas[*].properties
warn
security-schemes-defined
Security schemes should be defined in components.
$.components
warn
error-schema-defined
A shared error schema (InternalServiceErrorException) should be defined for error payloads.
$.components.schemas
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description