Amazon Augmented AI · API Governance Rules
Amazon Augmented AI API Rules
Spectral linting rules defining API design standards and conventions for Amazon Augmented AI.
18 Rules
error 7
warn 11
Rule Categories
a2i
no
query
schema
security
servers
Rules
warn
a2i-operation-id-camel-case
All operationIds must be camelCase
$.paths[*][*].operationId
warn
a2i-summary-prefix
All operation summaries must start with Amazon Augmented AI
$.paths[*][*].summary
warn
a2i-has-tags
All operations must have tags
$.paths[*][*]
error
a2i-response-200
All operations must have a 200 response
$.paths[*][*].responses
error
a2i-human-loop-name-required
StartHumanLoopRequest must require HumanLoopName
$.components.schemas.StartHumanLoopRequest
error
a2i-human-loop-status-enum
HumanLoopStatus must use valid enum values
$.components.schemas.HumanLoopSummary.properties.HumanLoopStatus
error
a2i-security-sigv4
API must use sigv4 security scheme
$.security[*]
warn
a2i-server-url-fixed
Server URL must be fixed without variables
$.servers[*]
warn
a2i-example-microcks-default
All examples must have x-microcks-default set to true
$.paths[*][*].responses[*].content[*].examples.default
error
a2i-human-loop-input-required
StartHumanLoopRequest must require HumanLoopInput
$.components.schemas.StartHumanLoopRequest.required
error
a2i-flow-definition-arn-required
StartHumanLoopRequest must require FlowDefinitionArn
$.components.schemas.StartHumanLoopRequest.properties.FlowDefinitionArn
error
servers-https-only
Server URLs must use HTTPS.
$.servers[*].url
warn
servers-expected-domain
Server URLs should be on the amazonaws.com domain.
$.servers[*].url
warn
query-params-casing
Query parameters should be PascalCase (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
warn
schema-names-casing
Component schema names should be PascalCase (the dominant convention in this API).
$.components.schemas
warn
schema-properties-casing
Schema properties should be PascalCase (the dominant convention in this API).
$.components.schemas[*].properties
warn
security-schemes-defined
Security schemes should be defined in components.
$.components
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description