rules:
  info-title-required:
    description: Info title must be present and non-empty.
    severity: error
    given: "$.info"
    then:
      field: title
      function: truthy

  info-description-required:
    description: Info description must be present.
    severity: warn
    given: "$.info"
    then:
      field: description
      function: truthy

  info-version-required:
    description: Info version must be present.
    severity: error
    given: "$.info"
    then:
      field: version
      function: truthy

  openapi-version-3:
    description: OpenAPI version must be 3.x.
    severity: error
    given: "$"
    then:
      field: openapi
      function: pattern
      functionOptions:
        match: "^3\\."

  servers-required:
    description: Servers must be defined.
    severity: error
    given: "$"
    then:
      field: servers
      function: truthy

  servers-https:
    description: All server URLs must use HTTPS.
    severity: error
    given: "$.servers[*]"
    then:
      field: url
      function: pattern
      functionOptions:
        match: "^https://"

  paths-no-trailing-slash:
    description: Paths must not have trailing slashes.
    severity: warn
    given: "$.paths[*]~"
    then:
      function: pattern
      functionOptions:
        notMatch: "/$"

  operation-operationId-required:
    description: Every operation must have an operationId.
    severity: error
    given: "$.paths[*][get,post,put,patch,delete]"
    then:
      field: operationId
      function: truthy

  operation-summary-required:
    description: Every operation must have a summary.
    severity: error
    given: "$.paths[*][get,post,put,patch,delete]"
    then:
      field: summary
      function: truthy

  operation-summary-company-prefix:
    description: Operation summaries must start with 'Amazon Migration Hub'.
    severity: warn
    given: "$.paths[*][get,post,put,patch,delete].summary"
    then:
      function: pattern
      functionOptions:
        match: "^Amazon Migration Hub"

  operation-description-required:
    description: Every operation must have a description.
    severity: warn
    given: "$.paths[*][get,post,put,patch,delete]"
    then:
      field: description
      function: truthy

  operation-tags-required:
    description: Every operation must have at least one tag.
    severity: warn
    given: "$.paths[*][get,post,put,patch,delete]"
    then:
      field: tags
      function: truthy

  parameter-description-required:
    description: All parameters must have a description.
    severity: warn
    given: "$.paths[*][get,post,put,patch,delete].parameters[*]"
    then:
      field: description
      function: truthy

  response-description-required:
    description: All responses must have a description.
    severity: error
    given: "$.paths[*][get,post,put,patch,delete].responses[*]"
    then:
      field: description
      function: truthy

  schema-property-type-required:
    description: Schema properties should define a type.
    severity: info
    given: "$.components.schemas[*].properties[*]"
    then:
      field: type
      function: truthy

  security-schemes-defined:
    description: Security schemes should be defined in components.
    severity: warn
    given: "$.components"
    then:
      field: securitySchemes
      function: truthy

  get-no-request-body:
    description: GET operations must not have a request body.
    severity: error
    given: "$.paths[*].get"
    then:
      field: requestBody
      function: falsy

  tag-description-required:
    description: All tags should have a description.
    severity: info
    given: "$.tags[*]"
    then:
      field: description
      function: truthy

  schema-description-required:
    description: Top-level schemas should have descriptions.
    severity: info
    given: "$.components.schemas[*]"
    then:
      field: description
      function: truthy

  operation-id-camel-case:
    description: OperationId should use camelCase.
    severity: info
    given: "$.paths[*][get,post,put,patch,delete].operationId"
    then:
      function: pattern
      functionOptions:
        match: "^[a-z][a-zA-Z0-9]*$"