path-item-parameter-name-exceeds-maximum-allowed-length
Overview
This rule belongs to the openapi-v3-codegen-linting ruleset and states that:
Parameter name within the path item must not exceed 100 characters. Names exceeding this limit will cause failures in Code Generation, Docs Generation, and Portal Generation.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Path item parameter name exceeds the maximum allowed length of 100 characters. |
| Code | OPENAPI3CODEGEN_L174 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Path Items |
| Products Impacted | Code Generation, Developer Experience Portal |
| Tags | code generation sdks openapi3 openapi semantic linting apimatic path parameter parameters name length 100 characters |
Suggested Fixes
- Shorten the parameter name so that it doesn't exceed 100 characters.
- Try to keep the name under 50 characters for best results.