Amazon Athena · API Governance Rules
Amazon Athena API Rules
Spectral linting rules defining API design standards and conventions for Amazon Athena.
19 Rules
error 12
warn 7
Rule Categories
athena
Rules
error
athena-query-string-required
StartQueryExecution must require QueryString
$.components.schemas.StartQueryExecutionInput
warn
athena-operation-id-camel-case
All operationIds must be camelCase
$.paths[*][*].operationId
warn
athena-summary-prefix
All operation summaries must start with Amazon Athena
$.paths[*][*].summary
warn
athena-has-tags
All operations must have tags
$.paths[*][*]
warn
athena-server-url-fixed
Server URL must be fixed without variables
$.servers[*]
error
athena-response-200
All operations must have a 200 response
$.paths[*][*].responses
error
athena-request-body-required
POST operations must have a request body
$.paths[*].post
error
athena-query-execution-id-string
QueryExecutionId must be of type string
$.components.schemas[*].properties.QueryExecutionId
error
athena-named-query-id-string
NamedQueryId must be of type string
$.components.schemas[*].properties.NamedQueryId
error
athena-work-group-state-enum
WorkGroup State must use valid enum values
$.components.schemas.WorkGroup.properties.State
error
athena-data-catalog-type-enum
DataCatalog Type must use valid enum values
$.components.schemas.DataCatalog.properties.Type
error
athena-query-status-state-enum
QueryExecutionStatus State must use valid enum values
$.components.schemas.QueryExecutionStatus.properties.State
error
athena-tag-key-defined
Tag schema must define Key property
$.components.schemas.Tag.properties
error
athena-tag-value-defined
Tag schema must define Value property
$.components.schemas.Tag.properties
warn
athena-result-configuration-output-location
ResultConfiguration must have OutputLocation
$.components.schemas.ResultConfiguration.properties
warn
athena-engine-version-defined
EngineVersion schema must be defined
$.components.schemas
error
athena-column-info-name-defined
ColumnInfo must define Name property
$.components.schemas.ColumnInfo.properties
warn
athena-example-microcks-default
All examples must have x-microcks-default set to true
$.paths[*][*].requestBody.content[*].examples.default
error
athena-security-sigv4
API must use sigv4 security scheme
$.security[*]