ACORD 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 with meaningful content
    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: ACORD 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 should use HTTPS in production
    severity: warn
    given: "$.servers[*]"
    then:
      field: url
      function: pattern
      functionOptions:
        match: "^https://"

  # PATHS — NAMING CONVENTIONS
  paths-kebab-case:
    description: Path segments should use kebab-case
    severity: warn
    given: "$.paths[*]~"
    then:
      function: pattern
      functionOptions:
        match: "^(\\/[a-z][a-z0-9-]*)(\\/(\\{[a-z][a-zA-Z0-9]*\\}|[a-z][a-z0-9-]*))*$"

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

  # 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-id-camel-case:
    description: operationId should use camelCase
    severity: warn
    given: "$.paths[*][get,post,put,patch,delete].operationId"
    then:
      function: pattern
      functionOptions:
        match: "^[a-z][a-zA-Z0-9]*$"

  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-acord-prefix:
    description: ACORD operation summaries should start with 'ACORD'
    severity: info
    given: "$.paths[*][get,post,put,patch,delete].summary"
    then:
      function: pattern
      functionOptions:
        match: "^ACORD "

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

  tags-description-required:
    description: All global tags should have descriptions
    severity: warn
    given: "$.tags[*]"
    then:
      field: description
      function: truthy

  # PARAMETERS
  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

  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

  # REQUEST BODIES
  request-body-description:
    description: Request bodies should have a description
    severity: warn
    given: "$.paths[*][post,put,patch].requestBody"
    then:
      field: description
      function: truthy

  # 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: ["204"]

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

  response-401-defined:
    description: APIs with authentication should define 401 responses
    severity: warn
    given: "$.paths[*][get,post,put,patch,delete].responses"
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          required: ["401"]

  response-404-on-id-paths:
    description: Paths with ID parameters should define 404 responses
    severity: warn
    given: "$.paths[*~[*Id}*]][get,patch,delete].responses"
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          required: ["404"]

  # SCHEMAS — PROPERTY NAMING
  schema-description-required:
    description: All top-level schemas should have a description
    severity: warn
    given: "$.components.schemas[*]"
    then:
      field: description
      function: truthy

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

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

  security-global-defined:
    description: Global security should be defined
    severity: warn
    given: "$"
    then:
      field: security
      function: truthy

  # 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 should have a request body
    severity: warn
    given: "$.paths[*].post"
    then:
      field: requestBody
      function: truthy

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

  microcks-operation-present:
    description: Operations should have x-microcks-operation for mock testing
    severity: info
    given: "$.paths[*][get,post,put,patch,delete]"
    then:
      field: x-microcks-operation
      function: truthy