Acquia API Rules

rules:
  # INFO / METADATA
  info-title-required:
    description: OpenAPI info.title must be present and non-empty
    severity: error
    given: "$.info"
    then:
      field: title
      function: truthy

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

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

  info-contact-required:
    description: API info should include contact information
    severity: warn
    given: "$.info"
    then:
      field: contact
      function: truthy

  # OPENAPI VERSION
  openapi-version-3x:
    description: Acquia APIs must use OpenAPI 3.x
    severity: error
    given: "$"
    then:
      field: openapi
      function: pattern
      functionOptions:
        match: "^3\\."

  # SERVERS
  servers-required:
    description: At least one server must be defined
    severity: error
    given: "$"
    then:
      field: servers
      function: truthy

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

  servers-acquia-cloud-domain:
    description: Acquia Cloud API server should use cloud.acquia.com domain
    severity: info
    given: "$.servers[*]"
    then:
      field: url
      function: pattern
      functionOptions:
        match: "acquia\\.com"

  # PATHS — NAMING CONVENTIONS
  paths-no-trailing-slash:
    description: Paths must not end with a trailing slash
    severity: error
    given: "$.paths[*]~"
    then:
      function: pattern
      functionOptions:
        notMatch: "\\/$"

  paths-uuid-format:
    description: Resource identifiers in paths should use UUID suffix pattern
    severity: info
    given: "$.paths[*]~"
    then:
      function: pattern
      functionOptions:
        match: "^\\/"

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

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

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

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

  operation-summary-acquia-prefix:
    description: Operation summaries should start with 'Acquia'
    severity: info
    given: "$.paths[*][get,post,put,patch,delete].summary"
    then:
      function: pattern
      functionOptions:
        match: "^Acquia "

  # TAGS
  tags-global-defined:
    description: Global tags array should be defined
    severity: warn
    given: "$"
    then:
      field: tags
      function: truthy

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

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

  parameter-uuid-naming:
    description: UUID path parameters should end with 'Uuid' suffix
    severity: info
    given: "$.paths[*][get,post,put,patch,delete].parameters[?(@.in == 'path')]"
    then:
      field: name
      function: pattern
      functionOptions:
        match: "Uuid$|Id$|Name$"

  # RESPONSES
  response-success-required:
    description: All operations must define at least one 2xx response
    severity: error
    given: "$.paths[*][get,post,put,patch,delete].responses"
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          anyOf:
            - required: ["200"]
            - required: ["201"]
            - required: ["202"]
            - required: ["204"]

  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

  response-401-unauthorized:
    description: Protected endpoints should define 401 Unauthorized responses
    severity: warn
    given: "$.paths[*][get,post,put,patch,delete].responses"
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          required: ["401"]

  response-403-forbidden:
    description: Protected endpoints should define 403 Forbidden responses
    severity: warn
    given: "$.paths[*][post,put,patch,delete].responses"
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          required: ["403"]

  # SCHEMAS
  schema-type-defined:
    description: Schema components should define a type
    severity: warn
    given: "$.components.schemas[*]"
    then:
      field: type
      function: truthy

  # SECURITY
  security-schemes-defined:
    description: Security schemes must be defined in components
    severity: error
    given: "$"
    then:
      field: components.securitySchemes
      function: truthy

  security-oauth2-scheme:
    description: Acquia Cloud API uses OAuth2 authentication
    severity: info
    given: "$.components.securitySchemes[*]"
    then:
      field: type
      function: pattern
      functionOptions:
        match: "oauth2"

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

  delete-no-request-body:
    description: DELETE operations should not have a request body
    severity: warn
    given: "$.paths[*].delete"
    then:
      field: requestBody
      function: falsy

  post-has-request-body:
    description: POST operations creating resources should have a request body
    severity: info
    given: "$.paths[*].post"
    then:
      field: requestBody
      function: truthy

  # ACQUIA-SPECIFIC CONVENTIONS
  actions-paths-pattern:
    description: Action endpoints should follow /resources/{id}/actions/{action-name} pattern
    severity: info
    given: "$.paths[*~\\/actions\\/]~"
    then:
      function: pattern
      functionOptions:
        match: "\\/actions\\/"

  hal-json-content-type:
    description: Acquia Cloud API responses use application/hal+json content type
    severity: info
    given: "$.paths[*][get,post,put,patch,delete].responses[*].content"
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          anyOf:
            - required: ["application/hal+json"]
            - required: ["application/json"]

  # GENERAL QUALITY
  no-empty-descriptions:
    description: Descriptions must not be empty strings
    severity: warn
    given: "$..description"
    then:
      function: pattern
      functionOptions:
        match: ".+"