Amazon Rekognition · API Governance Rules
Amazon Rekognition API Rules
Spectral linting rules defining API design standards and conventions for Amazon Rekognition.
18 Rules
error 8
warn 8
info 2
Rule Categories
info
operation
post
response
schema
security
servers
tag
Rules
warn
info-title-prefix
Info title must start with Amazon Rekognition
$.info.title
error
info-description-required
Info must have a description
$.info
error
info-version-required
Info must have a version
$.info
error
servers-required
At least one server must be defined
$
error
servers-https
Server URLs must use HTTPS
$.servers[*].url
error
operation-summary-required
All operations must have a summary
$.paths[*][*]
warn
operation-summary-prefix
Operation summaries must start with Amazon Rekognition
$.paths[*][*].summary
error
operation-description-required
All operations must have a description
$.paths[*][*]
error
operation-operationid-required
All operations must have an operationId
$.paths[*][*]
warn
operation-operationid-camelcase
OperationIds must use camelCase
$.paths[*][*].operationId
warn
operation-tags-required
All operations must have at least one tag
$.paths[*][*]
warn
operation-security-required
All operations should specify security
$.paths[*][*]
error
response-success-required
Operations must have a 2xx success response
$.paths[*][*].responses
warn
response-400-recommended
Operations should have a 400 error response
$.paths[*][*].responses
warn
schema-description-required
Top-level schemas should have descriptions
$.components.schemas[*]
warn
security-schemes-defined
Security schemes must be defined in components
$
info
post-must-use-amz-json
POST operations should use AWS JSON content type
$.paths[*].post.requestBody.content
info
tag-descriptions-required
Global tags should have descriptions
$.tags[*]