Skip to main content

valid-schema-title

Overview

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

For successful Code Generation, the schema title must only use letters, numbers, underscores and dashes. It must not contain any leading/trailing white-space characters.

PropertyValue
EnabledYes
Maximum SeverityError
MessageSchema title is invalid.
CodeOPENAPI3CODEGENSYNTAX_L610
TypeLinting
Rule SystemSyntax
Broad CategoryOpenAPI Schemas
Products ImpactedCode Generation, Developer Experience Portal
Tagscode generation sdks openapi3 openapi syntax linting apimatic schema title

Suggested Fixes

  • Make sure the title of the schema does not contain any forbidden characters.
  • Use only letters, numbers, underscores and dashes.
  • Remove any trailing/leading white-space characters, if present.

For More Information