Amazon CodeArtifact · API Governance Rules
Amazon CodeArtifact API Rules
Spectral linting rules defining API design standards and conventions for Amazon CodeArtifact.
23 Rules
error 11
warn 10
info 2
Rule Categories
delete
get
info
no
openapi
operation
parameter
response
schema
security
servers
Rules
warn
info-title-format
API title should identify CodeArtifact service
$.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
Must use OpenAPI 3.0.x
$.openapi
error
servers-defined
Servers must be defined
$
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,head,options]
warn
operation-summary-amazon-prefix
Operation summaries should start with Amazon CodeArtifact
$.paths[*][get,post,put,delete,patch].summary
warn
operation-description-required
Every operation must have a description
$.paths[*][get,post,put,delete,patch,head,options]
error
operation-operationId-required
Every operation must have an operationId
$.paths[*][get,post,put,delete,patch,head,options]
warn
operation-operationId-camelcase
operationId should use camelCase
$.paths[*][get,post,put,delete,patch].operationId
warn
operation-tags-required
Every operation must have tags
$.paths[*][get,post,put,delete,patch]
warn
parameter-description-required
Every parameter must have a description
$.paths[*][*].parameters[*]
error
parameter-schema-required
Every parameter must have a schema
$.paths[*][*].parameters[*]
error
response-success-required
Every operation must define at least one 2xx response
$.paths[*][get,post,put,delete,patch]
error
response-description-required
Every response must have a description
$.paths[*][*].responses[*]
info
schema-property-description
Schema properties should have descriptions
$.components.schemas[*].properties[*]
warn
schema-type-required
Schema components should have a type defined
$.components.schemas[*]
error
security-schemes-defined
Security schemes must be defined in components
$.components
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
warn
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
operation-examples-encouraged
Operations should include examples for Microcks compatibility
$.paths[*][get,post,put,delete,patch]