Skip to main content

maximum-server-name-length

Overview

This rule belongs to the openapi-v3-codegen-linting ruleset and states that:

The length of the server name should not exceed 50 characters, as longer names can lead to problems in code generation and negatively impact user-friendliness.

PropertyValue
EnabledYes
Maximum SeverityWarning
MessageServer name violates maximum length restrictions.
CodeOPENAPI3CODEGEN_L095
TypeLinting
Rule SystemSemantic
Broad CategoryOpenAPI Servers
Products ImpactedCode Generation, Developer Experience Portal
Tagscode generation sdks openapi3 openapi semantic linting apimatic server name length 50 characters

Suggested Fixes

  • Shorten the server name so that it does not exceed the limit.
  • Try to keep the name under 25 characters.

For More Information