Amazon Data Pipeline API Rules

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