Amazon Data Pipeline · API Governance Rules
Amazon Data Pipeline API Rules
Spectral linting rules defining API design standards and conventions for Amazon Data Pipeline.
22 Rules
error 13
warn 5
info 4
Rule Categories
action
all
info
no
openapi
operation
pipeline
request
response
schema
security
servers
tags
validation
Rules
warn
info-title-prefix
API title must start with "AWS Data Pipeline"
$.info.title
error
info-description-required
Info object must have a description
$.info
error
info-version-required
Info object must have a version
$.info
error
openapi-version-3x
Must use OpenAPI 3.x
$
error
servers-defined
Servers array must be defined
$
error
servers-https-only
All server URLs must use HTTPS
$.servers[*].url
info
action-based-paths
AWS Data Pipeline uses Action-based path conventions with ?Action= query parameter
$.paths[*]~
info
all-operations-use-post
AWS Data Pipeline uses POST for all operations
$.paths[*][get,put,patch,delete]
error
operation-summary-required
All operations must have a summary
$.paths[*][post]
error
operation-description-required
All operations must have a description
$.paths[*][post]
error
operation-id-required
All operations must have an operationId
$.paths[*][post]
warn
operation-id-camel-case
OperationId must use camelCase
$.paths[*][post].operationId
error
operation-tags-required
All operations must have tags
$.paths[*][post]
warn
request-body-json-content
All POST operations should support application/json
$.paths[*].post.requestBody.content
warn
tags-defined
Tags array should be defined globally
$
error
response-success-required
All operations must have a 200 response
$.paths[*][post].responses
error
response-description-required
All responses must have a description
$.paths[*][*].responses[*]
warn
schema-description-required
Top-level schemas should have a description
$.components.schemas[*]
error
security-schemes-defined
Security schemes must be defined
$.components
error
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
pipeline-id-in-operations
Pipeline operations should reference pipelineId in request body
$.components.schemas[?(@ =~ /Request/)].properties
info
validation-output-has-errored
Validation operation responses should include errored field
$.components.schemas.PutPipelineDefinitionOutput.properties