Amazon Fargate · API Governance Rules
Amazon Fargate API Rules
Spectral linting rules defining API design standards and conventions for Amazon Fargate.
29 Rules
error 10
warn 15
info 4
Rule Categories
info
no
openapi
operation
request
response
schema
security
servers
tag
tags
Rules
error
info-title-required
API must have a title in info
$.info
warn
info-title-amazon-fargate-prefix
API title must start with Amazon Fargate
$.info.title
error
info-description-required
API must have a description
$.info
error
info-version-required
API must have a version
$.info
warn
openapi-version-3-1
Must use OpenAPI 3.1.x
$
error
servers-required
Must define at least one server
$
error
servers-https-only
Server URLs must use HTTPS
$.servers[*].url
error
operation-operationid-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-operationid-camelcase
operationId must use camelCase
$.paths[*][get,post,put,patch,delete].operationId
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-summary-amazon-fargate-prefix
Operation summary must start with Amazon Fargate
$.paths[*][get,post,put,patch,delete].summary
warn
operation-description-required
Every operation must have a description
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete,head,options]
warn
tags-defined
Global tags array must be defined
$
warn
tag-description-required
Each tag must have a description
$.tags[*]
warn
request-body-json-content-type
Request bodies should use application/x-amz-json-1.1 or application/json
$.paths[*][post,put,patch].requestBody.content
error
response-success-required
Every operation must have a 2xx success response
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
Every response must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
warn
response-error-400
Operations should have a 400 error response
$.paths[*][post,put,patch].responses
warn
response-error-500
Operations should document 500 server errors
$.paths[*][get,post,put,patch,delete].responses
warn
schema-description-required
Component schemas must have descriptions
$.components.schemas[*]
info
schema-property-description
Schema properties should have descriptions
$.components.schemas[*].properties[*]
warn
schema-type-defined
Schema properties must define a type
$.components.schemas[*].properties[*]
error
security-schemes-defined
Security schemes must be defined in components
$.components
warn
security-global-defined
Global security must be defined
$
info
security-aws-sig-v4
Should use AWS Signature V4 authentication
$.components.securitySchemes
info
operation-amz-json-content-type
Amazon API operations should use application/x-amz-json-1.1 content type
$.paths[*][post].requestBody.content
info
operation-microcks-extension
Operations should have x-microcks-operation extension for mock support
$.paths[*][get,post,put,patch,delete]
warn
no-empty-descriptions
Descriptions must not be empty strings
$..description