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.
Property | Value |
---|---|
Enabled | Yes |
Maximum Severity | Error |
Message | Schema title is invalid. |
Code | OPENAPI3CODEGENSYNTAX_L610 |
Type | Linting |
Rule System | Syntax |
Broad Category | OpenAPI Schemas |
Products Impacted | Code Generation, Developer Experience Portal |
Tags | code 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.