Amazon Entity Resolution · API Governance Rules
Amazon Entity Resolution API Rules
Spectral linting rules defining API design standards and conventions for Amazon Entity Resolution.
20 Rules
error 10
warn 9
info 1
Rule Categories
delete
get
info
no
openapi
operation
parameter
response
schema
security
servers
Rules
error
info-title-required
OpenAPI info must have a title.
$.info
warn
info-description-required
OpenAPI info must have a description.
$.info
error
info-version-required
OpenAPI info must have a version.
$.info
error
openapi-version-3
Must use OpenAPI 3.x.
$
error
servers-required
OpenAPI must define at least one server.
$
error
servers-https-required
All server URLs must use HTTPS.
$.servers[*]
error
operation-summary-required
All operations must have a summary.
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-description-required
All operations must have a description.
$.paths[*][get,post,put,patch,delete,head,options]
error
operation-operationId-required
All operations must have an operationId.
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-operationId-camelCase
operationId must use camelCase.
$.paths[*][get,post,put,patch,delete,head,options].operationId
warn
operation-tags-required
All operations must have at least one tag.
$.paths[*][get,post,put,patch,delete,head,options]
warn
parameter-description-required
All parameters must have a description.
$.paths[*][get,post,put,patch,delete,head,options].parameters[*]
error
operation-success-response-required
All operations must define at least one 2xx response.
$.paths[*][get,post,put,patch,delete,head,options].responses
error
response-description-required
All responses must have a description.
$.paths[*][get,post,put,patch,delete,head,options].responses[*]
warn
security-schemes-defined
Security schemes must be defined in components.
$.components
warn
schema-properties-have-types
Schema properties should specify a type.
$.components.schemas[*].properties[*]
info
schema-description-required
Top-level component schemas should have a description.
$.components.schemas[*]
error
get-no-request-body
GET operations must not have a request body.
$.paths[*].get
warn
delete-no-request-body
DELETE operations should not have a request body.
$.paths[*].delete
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description