valid-schema-component-key

Overview

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

For successful Code Generation, the Schema Component key 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 Component key is invalid.
Code	OPENAPI3CODEGENSYNTAX_L130
Type	Linting
Rule System	Syntax
Broad Category	OpenAPI Components
Products Impacted	Code Generation, Developer Experience Portal
Tags	code generation sdks openapi3 openapi syntax linting apimatic schema name key

Suggested Fixes

• Make sure the schema component key does not contain any forbidden characters.
• Use only letters, numbers, underscores and dashes.
• Remove any trailing/leading white-space characters, if present.
• If the key of the schema component cannot be changed, remove the schema component definition and its references (if any), to avoid issues.

For More Information

• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#components-object
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schema-object
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
• https://docs.apimatic.io/rulesets/overview/