casing.yml

rules:
  paths-kebab-case:
    description: |
      Paths should be kebab-case (e.g. `path-parameter`).

      See Italian recommendation RAC_REST_NAME_002.
    message: '{{property}} is not kebab-case: {{error}}'
    severity: warn
    recommended: true
    given: $.paths[*]~
    then:
      # BEWARE: don't use `casing` because  this pattern allows
      #         for non-kebab parameters in the path.
      function: pattern
      functionOptions:
        match: "^(\/[a-z0-9-.]+|\/{[a-zA-Z0-9_]+})+$"

  request-headers-pascal-case: &request-headers-pascal-case
    description: |
      Headers should be pascal-case, separated by hyphens (e.g. `PascalCase-Header`)

      See Italian recommendation RAC_REST_NAME_003.
    message: '{{value}} {{error}} in {{path}}'
    severity: hint
    recommended: true
    given:
    - $..[parameters][?(@.in=="header")].name
    then:
      function: casing
      functionOptions:
        type: pascal
        separator:
          char: '-'
  response-headers-pascal-case:
    <<: *request-headers-pascal-case
    message: 'Header {{error}}: {{path}}'
    given:
    - $..[responses][*].headers.*~

  schema-camel-case:
    description: |-
      Schema definitions should be CamelCase
      (pascal case with blank separator char).

      This improves readability and avoid
      confusion between schema names and properties.

      ```
      Website:
        type: string
        format: url
      Person:
        type: object
        properties:
          website:
            $ref: "#/components/schemas/Website"
      ``` 
    message: 'Schema name should be CamelCase in {{path}}'
    severity: hint
    recommended: true
    given: >-
      $.components.schemas[*]~
    then:
      function: casing
      functionOptions:
        type: pascal
        separator:
          char: ""