OpenAPI Schema Names Snake Case (Edit)

Schema component keys should use snake_case naming convention for consistency, particularly in APIs that follow Python or Ruby conventions.

OpenAPISchemaNamingCasing

Rule Definition

openapi-schema-names-snake-case-info.yaml
{"openapi-schema-names-snake-case-info":{"description":"Schema component keys should use snake_case naming convention for consistency, particularly in APIs that follow Python or Ruby conventions.","message":"Schema key SHOULD be snake_case.","given":"$.components.schemas.*~","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^[a-z][a-z0-9]*(_[a-z0-9]+)*$"}}}}

Back to All of the Rules