Skip to main content

info-title-exceeds-maximum-allowed-length

Overview

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

The title assigned to the API in the Info Object must not exceed 100 characters. Titles exceeding this limit will cause failures in Code Generation, Docs Generation, and Portal Generation.

PropertyValue
EnabledYes
Maximum SeverityError
MessageAPI title exceeds the maximum allowed length of 100 characters.
CodeOPENAPI3CODEGEN_L051
TypeLinting
Rule SystemSemantic
Broad CategoryOpenAPI Info
Products ImpactedCode Generation, Developer Experience Portal
Tagscode generation sdks openapi3 openapi semantic linting apimatic length title info api

Suggested Fixes

  • Shorten the info title so that it doesn't exceed 100 characters.
  • Try to keep the title under 50 characters for best results.

For More Information