rulesAdidas.json

{
    "extends": [
      "spectral:oas"
    ],
    "rules": {
      "operation-operationId": false,
      "operation-tags": false,
      "operation-2xx-response": "error",
      "adidas-paths-kebab-case": {
        "description": "All YAML/JSON paths MUST follow kebab-case",
        "severity": "warn",
        "recommended": true,
        "message": "{{property}} is not kebab-case: {{error}}",
        "given": "$.paths[*]~",
        "then": {
          "function": "pattern",
          "functionOptions": {
            "match": "^/([a-z0-9]+(-[a-z0-9]+)*)?(/[a-z0-9]+(-[a-z0-9]+)*|/{.+})*$"
          }
        }
      },
      "adidas-path-parameters-camelCase-alphanumeric": {
        "description": "Path parameters MUST follow camelCase",
        "severity": "warn",
        "recommended": true,
        "message": "{{property}} path parameter is not camelCase: {{error}}",
        "given": "$..parameters[?(@.in == 'path')].name",
        "then": {
          "function": "pattern",
          "functionOptions": {
            "match": "^[a-z][a-zA-Z0-9]+$"
          }
        }
      },
      "adidas-definitions-camelCase-alphanumeric": {
        "description": "All YAML/JSON definitions MUST follow fields-camelCase and be ASCII alphanumeric characters or `_` or `$`.",
        "severity": "error",
        "recommended": true,
        "message": "{{property}} MUST follow camelCase and be ASCII alphanumeric characters or `_` or `$`.",
        "given": "$.definitions[*]~",
        "then": {
          "function": "pattern",
          "functionOptions": {
            "match": "/^[a-z$_]{1}[A-Z09$_]*/"
          }
        }
      },
      "adidas-properties-camelCase-alphanumeric": {
        "description": "All JSON Schema properties MUST follow fields-camelCase and be ASCII alphanumeric characters or `_` or `$`.",
        "severity": "error",
        "recommended": true,
        "message": "{{property}} MUST follow camelCase and be ASCII alphanumeric characters or `_` or `$`.",
        "given": "$.definitions..properties[*]~",
        "then": {
          "function": "pattern",
          "functionOptions": {
            "match": "/^[a-z$_]{1}[A-Z09$_]*/"
          }
        }
      },
      "adidas-request-GET-no-body": {
        "description": "A 'GET' request MUST NOT accept a 'body` parameter",
        "severity": "error",
        "given": "$.paths..get.parameters..in",
        "then": {
          "function": "pattern",
          "functionOptions": {
            "notMatch": "/^body$/"
          }
        }
      },
      "adidas-headers-no-x-headers": {
        "description": "All 'HTTP' headers SHOULD NOT include 'X-' headers (https://tools.ietf.org/html/rfc6648).",
        "severity": "warn",
        "given": "$..parameters[?(@.in == 'header')].name",
        "message": "HTTP headers SHOULD NOT include 'X-' prefix.",
        "recommended": true,
        "type": "style",
        "then": {
          "function": "pattern",
          "functionOptions": {
            "notMatch": "/^(x|X)-/"
          }
        }
      },
      "adidas-headers-hyphenated-pascal-case": {
        "description": "All `HTTP` headers MUST use `Hyphenated-Pascal-Case` notation",
        "severity": "error",
        "given": "$..parameters[?(@.in == 'header')].name",
        "message": "'HTTP' headers MUST follow 'Hyphenated-Pascal-Case' notation",
        "recommended": true,
        "type": "style",
        "then": {
          "function": "pattern",
          "functionOptions": {
            "match": "/^([A-Z][a-z0-9]-)*([A-Z][a-z0-9])+/"
          }
        }
      },
      "adidas-oas2-protocol-https-only": {
        "description": "ALL requests MUST go through `https` protocol only",
        "formats": [
          "oas2"
        ],
        "recommended": true,
        "severity": "error",
        "type": "style",
        "message": "Schemes MUST be https and no other value is allowed.",
        "given": "$",
        "then": {
          "field": "schemes",
          "function": "schema",
          "functionOptions": {
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "https"
                ]
              },
              "maxItems": 1
            }
          }
        }
      },
      "adidas-oas2-request-support-json": {
        "description": "Every request SHOULD support `application/json` media type",
        "formats": [
          "oas2"
        ],
        "severity": "warn",
        "message": "{{description}}: {{error}}",
        "recommended": true,
        "given": "$..consumes",
        "then": {
          "function": "schema",
          "functionOptions": {
            "schema": {
              "type": "array",
              "contains": {
                "type": "string",
                "enum": [
                  "application/json"
                ]
              }
            }
          }
        }
      },
      "adidas-oas2-example-exists-in-parameters": {
        "description": "All models MUST have a valid example.",
        "severity": "error",
        "recommended": true,
        "formats": [
          "oas2"
        ],
        "message": "{{ property }} MUST have a valid example.",
        "given": "$..parameters..[?(@.in == 'body' && (@.example || @.schema.$ref))]",
        "then": {
          "function": "truthy"
        }
      },
      "adidas-oas2-response-success-hal": {
        "description": "All success responses MUST be of media type `application/hal+json`",
        "severity": "error",
        "given": "$.paths..responses[?( @property >= 200 && @property < 300 && @property != 204)]",
        "recommended": true,
        "type": "style",
        "formats": [
          "oas2"
        ],
        "message": "Response documents MUST follow application/hal+json: {{error}}",
        "then": {
          "field": "schema",
          "function": "schema",
          "functionOptions": {
            "schema": {
              "$ref": "./supermodel/adidas/api/HAL.yaml"
            }
          }
        }
      },
      "adidas-oas2-response-error-problem": {
        "description": "All error responses MUST be of media type `application/problem+json`",
        "severity": "error",
        "formats": [
          "oas2"
        ],
        "given": "$.paths..responses[?( @property >= 400 && @property < 600 )]",
        "recommended": true,
        "type": "style",
        "message": "Error response document MUST follow application/problem+json: {{error}}",
        "then": {
          "field": "schema.example",
          "function": "schema",
          "functionOptions": {
            "schema": {
              "$ref": "./supermodel/adidas/api/ProblemDetail.yaml"
            }
          }
        }
      },
      "adidas-oas3-request-support-json": {
        "description": "Every request MUST support `application/json` media type",
        "formats": [
          "oas3"
        ],
        "recommended": true,
        "severity": "error",
        "message": "{{description}}: {{error}}",
        "given": "$.paths.[*].requestBody.content[?(@property.indexOf('json') === -1)]^",
        "then": {
          "function": "falsy"
        }
      },
      "adidas-oas3-valid-example-in-parameters": {
        "description": "Examples must be valid against their defined schema.",
        "message": "{{error}}",
        "recommended": true,
        "formats": [
          "oas3"
        ],
        "severity": 0,
        "type": "validation",
        "given": "$..parameters..[?(@.in == 'body')]..[?(@property !== 'properties' && @.example && ( @.type || @.format || @.$ref ))]",
        "then": {
          "function": "schemaPath",
          "functionOptions": {
            "field": "example",
            "schemaPath": "$"
          }
        }
      },
      "adidas-oas3-valid-example-in-definitions": {
        "description": "Examples must be valid against their defined schema.",
        "message": "{{error}}",
        "recommended": true,
        "formats": [
          "oas3"
        ],
        "severity": 0,
        "type": "validation",
        "given": "$..definitions..[?(@property !== 'properties' && @.example && (@.type || @.format || @.$ref))]",
        "then": {
          "function": "schemaPath",
          "functionOptions": {
            "field": "example",
            "schemaPath": "$"
          }
        }
      },
      "adidas-oas3-protocol-https-only": {
        "description": "ALL requests MUST go through `https` protocol only",
        "formats": [
          "oas3"
        ],
        "recommended": true,
        "severity": "error",
        "message": "Servers MUST be https and no other protocol is allowed.",
        "given": "$.servers..url",
        "then": {
          "function": "pattern",
          "functionOptions": {
            "match": "/^https:/"
          }
        }
      },
      "adidas-oas3-response-success-hal": {
        "description": "All success responses MUST be of media type `application/hal+json` ",
        "severity": "error",
        "given": "$.paths..responses[?( @property >= 201 && @property < 300 && @property != 204)].content[*]~",
        "recommended": true,
        "formats": [
          "oas3"
        ],
        "message": "Response documents MUST be of application/hal+json media types: {{error}}",
        "then": {
          "function": "enumeration",
          "functionOptions": {
            "values": [
              "application/hal+json"
            ]
          }
        }
      },
      "adidas-oas3-response-success-OK": {
        "description": "All success responses MUST be of media type `application/hal+json` or `application/problem+json`",
        "severity": "error",
        "given": "$.paths..responses[?( @property == 200 )].content[*]~",
        "recommended": true,
        "formats": [
          "oas3"
        ],
        "message": "Response documents MUST be of application/hal+json or application/problem+json media types: {{error}}",
        "then": {
          "function": "enumeration",
          "functionOptions": {
            "values": [
              "application/hal+json",
              "application/problem+json"
            ]
          }
        }
      },
      "adidas-oas3-response-success-hal-body": {
        "description": "All success responses MUST follow `application/hal+json` schema",
        "severity": "error",
        "given": "$.paths..responses[?( @property == 200 && @property < 300 && @property != 204)].content[?(@property === \"application/hal+json\")]",
        "recommended": true,
        "type": "style",
        "formats": [
          "oas3"
        ],
        "message": "Response documents MUST follow application/hal+json schema: {{error}}",
        "then": {
          "field": "schema",
          "function": "schema",
          "functionOptions": {
            "schema": {
              "$ref": "./supermodel/adidas/api/HAL.yaml"
            }
          }
        }
      }
    }
  }