Amazon S3 API · API Governance Rules
Amazon S3 API API Rules
Spectral linting rules defining API design standards and conventions for Amazon S3 API.
19 Rules
error 4
warn 13
info 2
Rule Categories
error
no
operationid
path
query
s3
schema
security
servers
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
$
warn
servers-https-only
Server URLs must use HTTPS.
$.servers[*].url
warn
path-params-casing
Path parameters should be PascalCase (the dominant convention in this API).
$.paths[*].parameters[?(@.in=='path')].name
info
query-params-casing
Query parameters should be snake_case (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 (ObjectNotInActiveTierError) should be defined for error payloads.
$.components.schemas
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description