valid-rfc-6570-parameter-Name
Overview
This rule belongs to the openapi-v3-apimatic-syntax-linting ruleset and states that:
The OpenAPI specification uses parameter names to identify parameters in various parts of the API, such as path, query, header, and cookie parameters. To ensure interoperability and consistency across API implementations, this rule enforces the requirement that parameter names must follow the URI template syntax specified in RFC6570.
| Property | Value |
|---|---|
| Enabled | No |
| Maximum Severity | Warning |
| Message | Invalid parameter name found. |
| Code | OPENAPI3APIMATICSYNTAX_L331 |
| Type | Linting |
| Rule System | Syntax |
| Broad Category | OpenAPI Parameters |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi syntax linting apimatic parameter name RFC6570 |
Suggested Fixes
- Ensure that parameter name follows the regex pattern ^[A-Za-z0-9?_()]+$.