schema-enum-naming
Since 0.9.0 · In the rulesets: Strict at error, All at error
This rule ensures that all string values defined in the enum properties of
schema objects adhere to a predefined naming convention.
Rule details
Enum values are spelled by every consumer, in code and in messages, so a consumer who has seen one should be able to spell the next.
The schema-enum-naming rule checks the string values of the enum list of
every schema of an AsyncAPI document. For every value that is not in the
expected convention, it reports
Schema enum value '<value>' is not in the '<convention>' convention.
Values of other types (numbers, booleans, null, …) are ignored.
The recognised naming conventions are:
CONST_CASE(alsoUPPER_CASEandSCREAMING_SNAKE_CASE) - THIS_IS_CONST_CASEcamelCase- thisIsCamelCase, also with acronyms (userID)camelCaseStrict- thisIsCamelCase, but no two capitals in a row (userId, not userID)kebab-case- this-is-kebab-casePascalCase- ThisIsPascalCase, also with acronyms (HTTPServer)PascalCaseStrict- ThisIsPascalCase, but no two capitals in a row (HttpServer, not HTTPServer)Header-Case- This-Is-Header-Casesnake_case- this_is_snake_case
The default convention is CONST_CASE.
Turn the rule off when the API follows no naming convention for enum values in its schema objects.
Configuration
The configuration block is a naming convention name (see the “Rule details” section for a list of recognized names).
version: "1.0"
commands:
lint:
asyncapi:
rules:
schema-enum-naming: [warning, kebab-case]
Examples
Good. With the default configuration.
asyncapi: 3.0.0
info:
title: User Events
version: 1.0.0
components:
schemas:
UserStatus:
type: string
enum:
- ACTIVE
- INACTIVE
- BLOCKED
Bad. To use UserStatus properly, a consumer must always consult the
documentation.
asyncapi: 3.0.0
info:
title: User Events
version: 1.0.0
components:
schemas:
UserStatus:
type: string
enum:
- activeStatus
- inactive_status
- BLOCKED_STATUS
Turn it off or change its severity
In apigenie.yaml, off turns the rule off and warning or error sets its severity; a rule with options takes the severity and the options as a pair, [warning, options]. lint.asyncapi has the details.
commands:
lint:
asyncapi:
rules:
schema-enum-naming: off