Amazon Application Discovery Service · API Governance Rules
Amazon Application Discovery Service API Rules
Spectral linting rules defining API design standards and conventions for Amazon Application Discovery Service.
21 Rules
error 13
warn 6
info 2
Rule Categories
info
openapi
operation
paths
response
schema
security
servers
Rules
warn
info-title-prefix
API title must start with "Amazon Application Discovery Service"
$.info
error
info-description-required
API info must have a description
$.info
error
info-version-required
API info must have a version field
$.info
error
openapi-version-3x
Must use OpenAPI 3.x
$
error
servers-defined
Servers must be defined
$
error
servers-https
All server URLs must use HTTPS
$.servers[*]
warn
paths-kebab-case
Path segments must use kebab-case or camelCase with /v1/ prefix
$.paths
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 Application Discovery Service"
$.paths[*][get,post,put,patch,delete]
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-camel-case
OperationId must use camelCase
$.paths[*][get,post,put,patch,delete]
error
operation-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete]
error
response-success-required
Every operation must have a 200 success response
$.paths[*][get,post,put,patch,delete].responses
warn
response-500-defined
Operations should define a 500 error response
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
Every response must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
warn
schema-description-required
Top-level schemas should have descriptions
$.components.schemas[*]
error
security-defined
Global security must be defined
$
error
security-schemes-defined
Security schemes must be defined
$.components
info
operation-microcks-extension
Operations should have x-microcks-operation for mock server compatibility
$.paths[*][get,post,put,patch,delete]
info
operation-examples-encouraged
POST operations should have request/response examples
$.paths[*][post].requestBody.content.application/json