Amazon Clean Rooms · API Governance Rules
Amazon Clean Rooms API Rules
Spectral linting rules defining API design standards and conventions for Amazon Clean Rooms.
29 Rules
error 14
warn 13
info 2
Rule Categories
delete
get
info
microcks
no
openapi
operation
pagination
parameter
paths
response
schema
security
servers
Rules
error
info-title-prefix
API title must start with "Amazon Clean Rooms"
$.info.title
error
info-description-required
Info object must have a description
$.info
error
info-version-required
API must have a version
$.info
warn
info-contact-required
API must have contact information
$.info
error
openapi-version
Must use OpenAPI 3.x
$
error
servers-required
API must define at least one server
$
error
servers-https-only
All server URLs must use HTTPS
$.servers[*].url
warn
paths-kebab-case
Path segments should use kebab-case
$.paths[*]~
error
operation-operationId-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
operation-operationId-pascal-case
operationId must use PascalCase (AWS convention)
$.paths[*][get,post,put,patch,delete].operationId
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 Clean Rooms"
$.paths[*][get,post,put,patch,delete].summary
error
operation-description-required
Every operation must have a description
$.paths[*][get,post,put,patch,delete]
error
operation-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete]
warn
parameter-description-required
All parameters must have descriptions
$.paths[*][get,post,put,patch,delete].parameters[*]
warn
parameter-camel-case
Path and query parameters should use camelCase (AWS convention)
$.paths[*][get,post,put,patch,delete].parameters[*].name
error
response-success-required
Every operation must have a success response
$.paths[*][get,post,put,patch,delete]
error
response-description-required
All response codes must have descriptions
$.paths[*][get,post,put,patch,delete].responses[*]
warn
response-400-required
Operations should document 400 bad request
$.paths[*][post,put,patch].responses
warn
response-403-required
Operations should document 403 access denied
$.paths[*][get,post,put,patch,delete].responses
warn
response-500-required
Operations should document 500 internal server error
$.paths[*][get,post,put,patch,delete].responses
warn
schema-description-on-top-level
Top-level component schemas should have descriptions
$.components.schemas[*]
warn
security-schemes-defined
Security schemes must be defined
$.components
warn
security-global-defined
Global security must be defined
$
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
warn
delete-returns-200-or-204
DELETE operations should return 200 or 204
$.paths[*].delete.responses
error
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
microcks-operation-present
Operations should have x-microcks-operation extension
$.paths[*][get,post,put,patch,delete]
info
pagination-uses-next-token
List operations should use nextToken for pagination (AWS convention)
$.paths[*].get.parameters[?(@.name == 'nextToken')]