design/enum-in-prose

Values enumerated in prose ('one of: a, b, c') are invisible to schema validation: the model can misspell them and the server only finds out at call time. If the value set is closed, encode it as an enum.

Category
design
Default severity
warn
Weight
3
Max deduction
12

Why this category matters

The interesting half. Whether the surface is shaped around your users' intents or around your REST endpoints.

A rule deducts weight points from its category for each non-info finding, capped at maxDeduction. The composite is the mean of the six category scores — so a single noisy rule can never sink a whole surface on its own. Read the full scoring model.

Other design rules

Back to the full rule catalogue · Browse audited servers