Amazon AppFlow · API Governance Rules
Amazon AppFlow API Rules
Spectral linting rules defining API design standards and conventions for Amazon AppFlow.
34 Rules
error 17
warn 15
info 2
Rule Categories
delete
get
info
openapi
operation
parameter
paths
request
response
schema
security
servers
tag
tags
Rules
warn
info-title-prefix
API title must start with "Amazon AppFlow"
$.info
error
info-description-required
API info must have a description with at least 50 characters
$.info
error
info-version-required
API info must have a version field
$.info
warn
info-contact-required
API info should include contact information
$.info
error
openapi-version-3x
Must use OpenAPI 3.x specification
$
error
servers-defined
Servers must be defined
$
error
servers-https
All server URLs must use HTTPS
$.servers[*]
warn
servers-description
Each server should have a description
$.servers[*]
warn
paths-kebab-case
Path segments must use kebab-case
$.paths
error
paths-no-trailing-slash
Paths must not have trailing slashes
$.paths
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 AppFlow"
$.paths[*][get,post,put,patch,delete]
error
operation-description-required
Every operation must have a description
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
operation-id-camel-case
OperationId must use camelCase
$.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
tags-defined
Global tags array should be defined
$
warn
tag-description-required
Each global tag should have a description
$.tags[*]
error
parameter-description-required
Every parameter must have a description
$.paths[*][get,post,put,patch,delete].parameters[*]
error
parameter-schema-required
Every parameter must have a schema
$.paths[*][get,post,put,patch,delete].parameters[*]
warn
request-body-content-json
Request bodies should use application/json content type
$.paths[*][post,put,patch].requestBody.content
error
response-success-required
Every operation must have at least one 2xx response
$.paths[*][get,post,put,patch,delete].responses
warn
response-400-defined
POST operations should define a 400 error response
$.paths[*][post].responses
warn
response-500-defined
Operations should define a 500 error 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
schema-description-required
Top-level component schemas should have descriptions
$.components.schemas[*]
warn
schema-properties-type-defined
Schema properties should have a type defined
$.components.schemas[*].properties[*]
error
security-defined
Global security must be defined
$
error
security-schemes-defined
Security schemes must be defined in components
$.components
warn
security-scheme-description
Each security scheme should have a description
$.components.securitySchemes[*]
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
warn
delete-no-request-body
DELETE operations should not have a request body
$.paths[*].delete
info
operation-examples-encouraged
Operations should provide request/response examples for mock server compatibility
$.paths[*][post,put,patch].requestBody.content.application/json
info
operation-microcks-extension
Operations should have x-microcks-operation extension for mock server compatibility
$.paths[*][get,post,put,patch,delete]