Amazon S3 API · API Governance Rules
Amazon S3 API API Rules
Spectral linting rules defining API design standards and conventions for Amazon S3 API.
10 Rules
error 4
warn 5
info 1
Rule Categories
s3
Rules
warn
s3-operation-summary
All operations must have a summary starting with "Amazon S3"
$.paths[*][get,post,put,delete,patch,head]
error
s3-operation-id
All operations must have an operationId
$.paths[*][get,post,put,delete,patch,head]
error
s3-info-title
Info object must have a title
$.info
error
s3-info-version
Info object must have a version
$.info
error
s3-response-description
All responses must have a description
$.paths[*][*].responses[*]
warn
s3-parameter-description
All parameters should have a description
$.paths[*][*].parameters[*]
info
s3-microcks-annotation
Operations should have x-microcks-operation annotation
$.paths[*][get,post,put,delete,patch,head]
warn
s3-schema-type
Schema components should have a type
$.components.schemas[*]
warn
s3-security-defined
API security schemes should be defined
$
warn
s3-servers-defined
Servers array should be defined
$