Amazon Data Pipeline API Rules

# authorship: generated by API Evangelist tooling. Stamped 2026-08-18
# on the file's own generator header (roadmap#64). An unmarked file is
# NOT assumed to be ours -- absence of evidence was never stamped.
x-method: generated
# amazon-data-pipeline — 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
#   - operationid-casing: camel @ 100% (n=13)
#   - schema-names-casing: pascal @ 100% (n=34)
#   - schema-properties-casing: camel @ 53% (n=75)
#   - security: global (root) — NOT emitting operation-security-required
#   - error-schema-defined: ValidationError
#   - merge: kept 22 existing, added 4 measured, upgraded 0
#   - added: servers-expected-domain, schema-names-casing, schema-properties-casing, error-schema-defined
extends:
  - spectral:oas
rules:
  info-title-prefix:
    description: API title must start with "AWS Data Pipeline"
    severity: warn
    given: $.info.title
    then:
      function: pattern
      functionOptions:
        match: ^AWS Data Pipeline
  info-description-required:
    description: Info object must have a description
    severity: error
    given: $.info
    then:
      field: description
      function: truthy
  info-version-required:
    description: Info object must have a version
    severity: error
    given: $.info
    then:
      field: version
      function: truthy
  openapi-version-3x:
    description: Must use OpenAPI 3.x
    severity: error
    given: $
    then:
      field: openapi
      function: pattern
      functionOptions:
        match: ^3\.
  servers-defined:
    description: Servers array must be defined
    severity: error
    given: $
    then:
      field: servers
      function: truthy
  servers-https-only:
    description: All server URLs must use HTTPS
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: ^https://
  action-based-paths:
    description: AWS Data Pipeline uses Action-based path conventions with ?Action= query parameter
    severity: info
    given: $.paths[*]~
    then:
      function: pattern
      functionOptions:
        match: ^/\?Action=
  all-operations-use-post:
    description: AWS Data Pipeline uses POST for all operations
    severity: info
    given: $.paths[*][get,put,patch,delete]
    then:
      function: falsy
  operation-summary-required:
    description: All operations must have a summary
    severity: error
    given: $.paths[*][post]
    then:
      field: summary
      function: truthy
  operation-description-required:
    description: All operations must have a description
    severity: error
    given: $.paths[*][post]
    then:
      field: description
      function: truthy
  operation-id-required:
    description: All operations must have an operationId
    severity: error
    given: $.paths[*][post]
    then:
      field: operationId
      function: truthy
  operation-id-camel-case:
    description: OperationId must use camelCase
    severity: warn
    given: $.paths[*][post].operationId
    then:
      function: pattern
      functionOptions:
        match: ^[a-z][a-zA-Z0-9]+$
  operation-tags-required:
    description: All operations must have tags
    severity: error
    given: $.paths[*][post]
    then:
      field: tags
      function: truthy
  request-body-json-content:
    description: All POST operations should support application/json
    severity: warn
    given: $.paths[*].post.requestBody.content
    then:
      field: application/json
      function: truthy
  tags-defined:
    description: Tags array should be defined globally
    severity: warn
    given: $
    then:
      field: tags
      function: truthy
  response-success-required:
    description: All operations must have a 200 response
    severity: error
    given: $.paths[*][post].responses
    then:
      function: schema
      functionOptions:
        schema:
          required:
          - '200'
  response-description-required:
    description: All responses must have a description
    severity: error
    given: $.paths[*][*].responses[*]
    then:
      field: description
      function: truthy
  schema-description-required:
    description: Top-level schemas should have a description
    severity: warn
    given: $.components.schemas[*]
    then:
      field: description
      function: truthy
  security-schemes-defined:
    description: Security schemes must be defined
    severity: error
    given: $.components
    then:
      field: securitySchemes
      function: truthy
  no-empty-descriptions:
    description: Descriptions must not be empty strings
    severity: error
    given: $..description
    then:
      function: pattern
      functionOptions:
        match: .+
  pipeline-id-in-operations:
    description: Pipeline operations should reference pipelineId in request body
    severity: info
    given: $.components.schemas[?(@ =~ /Request/)].properties
    then:
      field: pipelineId
      function: truthy
  validation-output-has-errored:
    description: Validation operation responses should include errored field
    severity: info
    given: $.components.schemas.PutPipelineDefinitionOutput.properties
    then:
      field: errored
      function: truthy
  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
  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 camelCase (the dominant convention in this API).
    severity: info
    given: $.components.schemas[*].properties
    then:
      field: '@key'
      function: casing
      functionOptions:
        type: camel
  error-schema-defined:
    description: A shared error schema (ValidationError) should be defined for error payloads.
    severity: warn
    given: $.components.schemas
    then:
      field: ValidationError
      function: truthy