Linting Rules - OpenAPI V3 Components Parameters Pascal Case

Number of APIs: 1

This is a Spectral governance rule to enforce that the OpenAPI parameters within the components object are all using pascal case for the key. Here is a JSON version of the rule that can be applied using this API-driven collection API, or at CLI or CI/CD pipeline.

{
  "openapi-v3-components-parameters-pascal-case": {
    "description": "Ensuring that all components parameters are using pascal case for the name.",
    "message": "The component parameters name needs to be pascalCase.",
    "given": "$.components.parameters..[?(@.in==='query' || @.in==='path' || @.in==='cookie')]",
    "severity": "warn",
    "then": {
      "field": "name",
      "function": "casing",
      "functionOptions": {
        "type": "pascal"
      }
    }
  }
}

This request can be run as part of this collection, or dragged and dropped to another collection of governance requests organized by folder, demonstrating how API governance linting works, but also providing a rule that can be used as part of your wider API governance strategy.

1. OpenAPI V3 Components Parameters Pascal Case POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/openapi-v3-components-parameters-pascal-case/