Amazon Fault Injection Simulator · API Governance Rules
Amazon Fault Injection Simulator API Rules
Spectral linting rules defining API design standards and conventions for Amazon Fault Injection Simulator.
28 Rules
error 10
warn 16
info 2
Rule Categories
client
info
no
operation
path
paths
response
schema
security
servers
tag
tags
Rules
error
info-title-required
API must have a title
$.info
warn
info-title-aws-fis-prefix
Title must start with AWS Fault Injection Simulator
$.info.title
error
info-description-required
API must have a description
$.info
error
info-version-required
API must have a version
$.info
error
servers-required
API must define servers
$
error
servers-https
Server URLs must use HTTPS
$.servers[*].url
error
operation-operationid-required
Operations must have operationId
$.paths[*][get,post,put,patch,delete]
warn
operation-operationid-camelcase
operationId must use camelCase
$.paths[*][get,post,put,patch,delete].operationId
error
operation-summary-required
Operations must have summary
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-aws-fis-prefix
Summaries must start with AWS Fault Injection Simulator
$.paths[*][get,post,put,patch,delete].summary
warn
operation-description-required
Operations must have description
$.paths[*][get,post,put,patch,delete]
warn
operation-tags-required
Operations must have tags
$.paths[*][get,post,put,patch,delete]
info
operation-microcks-extension
Operations should have x-microcks-operation
$.paths[*][get,post,put,patch,delete]
warn
paths-kebab-case
Path segments should use kebab-case
$.paths
error
response-success-required
Operations must have a success response
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
Responses must have descriptions
$.paths[*][*].responses[*]
warn
response-error-400
Mutating operations should document 400
$.paths[*][post,put,patch].responses
warn
response-error-404
Operations on specific resources should document 404
$.paths[*][get,patch,delete].responses
warn
response-error-500
Operations should document 500
$.paths[*][*].responses
warn
schema-description-required
Component schemas must have descriptions
$.components.schemas[*]
warn
schema-type-defined
Schema properties should define type
$.components.schemas[*].properties[*]
error
security-schemes-defined
Security schemes must be defined
$.components
warn
security-global-defined
Global security must be defined
$
warn
path-parameters-described
Path parameters should have descriptions
$.paths[*][*].parameters[*][?(@.in=="path")]
warn
no-empty-descriptions
Descriptions must not be empty
$..description
warn
tags-defined
Global tags must be defined
$
warn
tag-description-required
Each tag must have a description
$.tags[*]
info
client-token-in-create
Create operations should include clientToken for idempotency
$.paths[*][post].requestBody.content