Skip to main content

schema-definition-camel-case

Requires names under components.schemas to use lower camelCase.

AttributeValue
CategoryMetadata
MaturityGold
OpenAPIOpenAPI 3.0, 3.1, 3.2
StarterOff
Lenient–CompleteError

Intent​

One schema naming style keeps references and generated model names predictable.

Flags​

Every component schema name that does not start with a lowercase ASCII letter followed only by ASCII letters or digits.

Does not flag​

Names such as payment, paymentMethod, and address2. Swagger 2.0 definitions are outside this implementation.

See it fail​

components:
schemas:
Payment_Method:
type: object

Diagnostic: Schema names should use camelCase.

Fix it​

components:
schemas:
paymentMethod:
type: object

Update every $ref to the renamed schema. Renaming a published component can affect generated client types.

Configure​

profiles:
default:
rules:
extends: [recommended]
override:
schema-definition-camel-case: warn

Nearby: component-name-unique, spec-components-invalid-map-name.