maximum-environment-name-length
Overview
This rule belongs to the openapi-v3-codegen-linting ruleset and states that:
The length of the environment name should not exceed 50 characters, as longer names can lead to problems in code generation and negatively impact user-friendliness.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | Environment name violates maximum length restrictions. |
| Code | OPENAPI3CODEGEN_L091 |
| 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 environment name length 50 characters |
Suggested Fixes
- Shorten the environment name so that it does not exceed the limit.
- Try to keep the name under 25 characters.