server-parameter-name-exceeds-maximum-allowed-length
Overview
This rule belongs to the openapi-v3-codegen-linting ruleset and states that:
The length of the server parameter name 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 | Server parameter name exceeds the maximum allowed length of 100 characters. |
| Code | OPENAPI3CODEGEN_L102 |
| 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 parameter name length 100 |
Suggested Fixes
- Shorten the server parameter name so that it doesn't exceed 100 characters.
- Try to keep the name under 50 characters for best results.
For More Information
- https://docs.apimatic.io/specification-extensions/swagger-server-configuration-extensions/#server-object
- https://docs.apimatic.io/specification-extensions/swagger-server-configuration-extensions/#parameter-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#server-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
- https://docs.apimatic.io/rulesets/overview/