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
View Rules File View on GitHub

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

Spectral Ruleset

Raw ↑
# amazon-augmented-ai — Spectral ruleset (strengthened)
# Plain Spectral. Existing hand-authored rules preserved; measured rules added
# from this provider's own OpenAPI conventions by strengthen_ruleset.py,
# then self-validated against the spec.
#
# Provenance:
#   - servers-https-only: 100% of servers already https (error)
#   - servers-expected-domain: 1/1 servers on amazonaws.com
#   - query-params-casing: pascal @ 100% (n=6)
#   - operationid-casing: camel @ 100% (n=5)
#   - schema-names-casing: pascal @ 100% (n=12)
#   - schema-properties-casing: pascal @ 100% (n=27)
#   - security: global (root) — NOT emitting operation-security-required
#   - merge: kept 11 existing, added 7 measured, upgraded 0
#   - added: servers-https-only, servers-expected-domain, query-params-casing, schema-names-casing, schema-properties-casing, security-schemes-defined, no-empty-descriptions
extends:
  - spectral:oas
rules:
  a2i-operation-id-camel-case:
    description: All operationIds must be camelCase
    message: '{{property}} must be camelCase'
    severity: warn
    given: $.paths[*][*].operationId
    then:
      function: pattern
      functionOptions:
        match: ^[a-z][a-zA-Z0-9]*$
  a2i-summary-prefix:
    description: All operation summaries must start with Amazon Augmented AI
    message: Summary must start with Amazon Augmented AI
    severity: warn
    given: $.paths[*][*].summary
    then:
      function: pattern
      functionOptions:
        match: ^Amazon Augmented AI
  a2i-has-tags:
    description: All operations must have tags
    message: Operation must have at least one tag
    severity: warn
    given: $.paths[*][*]
    then:
      field: tags
      function: truthy
  a2i-response-200:
    description: All operations must have a 200 response
    message: Operation must define a 200 response
    severity: error
    given: $.paths[*][*].responses
    then:
      field: '200'
      function: truthy
  a2i-human-loop-name-required:
    description: StartHumanLoopRequest must require HumanLoopName
    message: StartHumanLoopRequest must have HumanLoopName as required
    severity: error
    given: $.components.schemas.StartHumanLoopRequest
    then:
      field: required
      function: truthy
  a2i-human-loop-status-enum:
    description: HumanLoopStatus must use valid enum values
    message: HumanLoopStatus must be InProgress, Failed, Completed, Stopped, or Stopping
    severity: error
    given: $.components.schemas.HumanLoopSummary.properties.HumanLoopStatus
    then:
      field: enum
      function: truthy
  a2i-security-sigv4:
    description: API must use sigv4 security scheme
    message: Security must include sigv4
    severity: error
    given: $.security[*]
    then:
      field: sigv4
      function: defined
  a2i-server-url-fixed:
    description: Server URL must be fixed without variables
    message: Server URL must not use variables
    severity: warn
    given: $.servers[*]
    then:
      field: variables
      function: falsy
  a2i-example-microcks-default:
    description: All examples must have x-microcks-default set to true
    message: Example must have x-microcks-default true
    severity: warn
    given: $.paths[*][*].responses[*].content[*].examples.default
    then:
      field: x-microcks-default
      function: truthy
  a2i-human-loop-input-required:
    description: StartHumanLoopRequest must require HumanLoopInput
    message: StartHumanLoopRequest must have HumanLoopInput as required
    severity: error
    given: $.components.schemas.StartHumanLoopRequest.required
    then:
      function: truthy
  a2i-flow-definition-arn-required:
    description: StartHumanLoopRequest must require FlowDefinitionArn
    message: StartHumanLoopRequest must have FlowDefinitionArn as required
    severity: error
    given: $.components.schemas.StartHumanLoopRequest.properties.FlowDefinitionArn
    then:
      field: type
      function: truthy
  servers-https-only:
    description: Server URLs must use HTTPS.
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: ^https://
  servers-expected-domain:
    description: Server URLs should be on the amazonaws.com domain.
    severity: warn
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: amazonaws\.com
  query-params-casing:
    description: Query parameters should be PascalCase (the dominant convention in this API).
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
    then:
      field: name
      function: casing
      functionOptions:
        type: pascal
  schema-names-casing:
    description: Component schema names should be PascalCase (the dominant convention in this API).
    severity: warn
    given: $.components.schemas
    then:
      field: '@key'
      function: casing
      functionOptions:
        type: pascal
  schema-properties-casing:
    description: Schema properties should be PascalCase (the dominant convention in this API).
    severity: warn
    given: $.components.schemas[*].properties
    then:
      field: '@key'
      function: casing
      functionOptions:
        type: pascal
  security-schemes-defined:
    description: Security schemes should be defined in components.
    severity: warn
    given: $.components
    then:
      field: securitySchemes
      function: truthy
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: warn
    given: $..description
    then:
      function: truthy