server-variables-key-exceeds-maximum-allowed-length
Overview
This rule belongs to the openapi-v3-codegen-linting ruleset and states that:
The keys used for server variables must not exceed 100 characters. Keys exceeding this limit will cause failures in Code Generation, Docs Generation, and Portal Generation.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Server variable key exceeds the maximum allowed length of 100 characters. |
| Code | OPENAPI3CODEGEN_L101 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Servers |
| Products Impacted | Code Generation, Developer Experience Portal |
| Tags | code generation sdks openapi3 openapi semantic linting apimatic server variable name key length 100 |
Suggested Fixes
- Shorten the server variable key so that it doesn't exceed 100 characters.
- Try to keep the key under 50 characters for best results.