ruleset.bank.yml

aliases:
  requestOrResponseJsonContent:
    - "$..content[application/json]"

documentationUrl: https://www.guanchen.nl/

rules:
  bank-tag-requires-industry-value:
    description: Tags must be from the bank industry.
    message:
      This is not a bank industry value chain business capability keyword.
      Please make sure there is at least one qualified tag name.
    given:
      - $.tags.*.name
    severity: warn
    then:
      function: enumeration
      functionOptions:
        values:
          - Supervisory
          - Administrative

  bank-path-requires-kebab-case:
    description: Paths must be in kebab-case.
    message: Path is not in kebab-case.
    severity: warn
    given: "$.paths[*]~"
    then:
      - function: pattern
        functionOptions:
          match: "^(/([a-z0-9]+(-[a-z0-9]+)*|\\{[a-zA-Z0-9_]+\\}))*$"

  bank-header-requires-hyphenated-pascal-case:
    description: HTTP headers must be in Hyphenated-Pascal-Case.
    message: HTTP header is not in Hyphenated-Pascal-Case.
    severity: warn
    given:
      - "$..parameters[?(@.in == 'header')].name"
      - "$.components.securitySchemes[?(@.in == 'header')].name"
    then:
      function: pattern
      functionOptions:
        match: "^([A-Z][a-z0-9]*)(-[A-Z][a-z0-9]*)*$"

  bank-property-requires-camel-case:
    description: Property names, acronyms, path parameters and query parameters must be in camelCase.
    message: Property name, acronym, path parameter or query parameter is not in camelCase.
    severity: warn
    given:
      - "$..properties.*~"
      - $.paths.*.*.parameters[?(@.in=='path' || @.in=='query')].name
      - $.components.securitySchemes[?(@.in=='path' || @.in=='query')].name
    then:
      function: pattern
      functionOptions:
        match: ^[a-z][a-z0-9]*(([A-Z]{2}|[A-Z])[a-z0-9]+)*$

  bank-parameter-description-required:
    description: Parameters must have a description.
    message: Parameter is missing a description.
    severity: warn
    given: $.paths.*.*.parameters[*]
    then:
      field: description
      function: truthy

  bank-summary-well-formed:
    description: Operations must have a well-formed summary.
    message:
      Operation summary is not well-formed. Must start with a capital letter,
      containing only letters, numbers, and spaces, and no dots, and the total length should be at most 25 characters.
    severity: warn
    given: "$..summary"
    then:
      - function: pattern
        functionOptions:
          match: ^[A-Z][a-zA-Z0-9\s]{0,24}$

  bank-description-well-formed:
    description: Security schemes, parameters and operations must have a well-formed description.
    message: Security scheme, parameter or operation is not well-formed.
      Each sentence must start with a capital letter, end with a period,
      and the total length should be at least 15 characters. Markdown tables and URLs are allowed.
    severity: warn
    given:
      - $.paths.*.*.description
      - $.paths.*.*.parameters[*].description
      - $.components.securitySchemes[*].description
    then:
      - function: pattern
        functionOptions:
          match: ^(?!.*\|.*\n)(?=[\s\S]{15,})[A-Z][\s\S]*[.]$

  bank-operation-summary-required:
    description: Operations must have a summary.
    message: Operation is missing a summary.
    severity: warn
    given: $.paths.*.*
    then:
      field: summary
      function: truthy

  bank-operation-examples-required:
    description: Object types must include at least one example.
    message: Type is missing an example in the schema.
    severity: warn
    given: "#requestOrResponseJsonContent"
    then:
      field: schema.example
      function: truthy

  bank-operation-id-requires-pascal-case:
    description: Operation id's must be in PascalCase (upper camel case).
    message: Operation id is not in PascalCase.
    severity: warn
    given: "$..operationId"
    then:
      function: pattern
      functionOptions:
        match: "^[A-Z](([a-z0-9]+[A-Z]?)*)$"