Amazon CodePipeline · API Governance Rules
Amazon CodePipeline API Rules
Spectral linting rules defining API design standards and conventions for Amazon CodePipeline.
16 Rules
error 5
warn 9
info 2
Rule Categories
error
info
no
operation
operationid
query
response
schema
security
servers
Rules
error
info-description-required
API must have a description
$.info
error
servers-https
All server URLs must use HTTPS
$.servers[*].url
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,delete,patch]
warn
operation-summary-company-prefix
Operation summaries should start with Amazon CodePipeline
$.paths[*][get,post,put,delete,patch].summary
error
operation-operationId-required
Every operation must have an operationId
$.paths[*][get,post,put,delete,patch]
warn
operation-tags-required
Every operation must have tags
$.paths[*][get,post,put,delete,patch]
error
response-description-required
Every response must have a description
$.paths[*][*].responses[*]
warn
schema-type-required
Schema components should have a type
$.components.schemas[*]
warn
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
operation-microcks-operation
Operations should include x-microcks-operation
$.paths[*][get,post,put,delete,patch]
warn
query-params-casing
Query parameters should be camelCase (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
warn
operationid-casing
Operation IDs should be PascalCase (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].operationId
warn
schema-names-casing
Component schema names should be PascalCase (the dominant convention in this API).
$.components.schemas
info
schema-properties-casing
Schema properties should be camelCase (the dominant convention in this API).
$.components.schemas[*].properties
warn
security-schemes-defined
Security schemes should be defined in components.
$.components
warn
error-schema-defined
A shared error schema (ErrorDetails) should be defined for error payloads.
$.components.schemas