rules2.md

Parameters rules

1. path-parameters-must-be-kebab-case

path-parameters-must-be-kebab-case

An example of valid kebab case parameters, both defined at the path or operation level

Example of a wrongs parameters casing

#👻-failures: 2 path-parameters-must-be-kebab-case
openapi: 3.0.1
info:
  title: Test
  version: 1.0.0
paths:
  /cats/{dogId}: 
    get:
      parameters:
        - name: dogId #👻-fails-here: path-parameters-must-be-kebab-case
          in: path
          required: true
          schema:
            type: number
  /dogs/{catId}: 
    parameters:
      - name: catId #👻-fails-here: path-parameters-must-be-kebab-case
        in: path
        required: true
        schema:
          type: number
    get: {}
  /mouses/{mice-id}: 
    get:
      parameters:
        - name: mice-id #this should not fail
          in: path
          required: true
          schema:
            type: number

Spectral rule 🤖

This use the pathParameters alias to target both the parameters in the "paths" and the "operations.

#👻-rule
path-parameters-must-be-kebab-case:
  description: Path parameters must be kebab case
  given: "#parameters[?(@.in==\"path\")]"
  severity: error
  then:
    field: name
    function: pattern
    functionOptions:
      match: "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"

required-property-must-exist

#👻-failures: 1 required-property-must-exist
openapi: 3.0.1
info:
  title: Test
  version: 1.0.0
components:
  schemas: 
    Pet:
      required:
        - nestedschema
      type: object
      properties:
        name:
          type: string
        nestedschema:
          type: object 
          required:
            - id
            - nonexistent #👻-fails-here: required-property-must-exist
          properties: 
            id: 
              type: string

Spectral rule 🤖

This use the isRequiredPropertyDefined custom function.

#👻-rule
required-property-must-exist:
  description: Required property must exist
  message: "Required property must exist: {{error}}"
  given: $..required[*]
  severity: error
  then:
    function: isRequiredPropertyDefined