Skip to content

docs(error-catalog): VALUE_TOO_LONG / VALUE_TOO_SHORT name the field-level codes that really arrive #20004

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
objectstack-fleet wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

docs(error-catalog): VALUE_TOO_LONG / VALUE_TOO_SHORT name the field-level codes that really arrive #20004

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab8b19e
docs(error-catalog): VALUE_TOO_LONG / VALUE_TOO_SHORT name the field-…
claude Sep 24, 2026
37431df
docs(error-catalog): name where each length-miss path puts its field …
claude Sep 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 30 additions & 4 deletions content/docs/api/error-catalog.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,13 +215,39 @@ key runs no write-time check on any field type, so editing it changes nothing.
**Retry:** `no_retry`

### `VALUE_TOO_LONG`
**Cause:** String value exceeds the field's `maxLength` constraint.
**Fix:** Truncate the value to the maximum allowed length.
**Cause:** Reserved for a string value longer than its declared maximum. **No route emits it
today.** A length miss is refused as a *field-level* `max_length` entry instead, and where that
entry rides depends on what was written:

- **a record write** (a string over a field's `maxLength`) and **a request body a route parses
with Zod** answer `400 VALIDATION_FAILED` with the entry in `fields[]` — top-level on the
`/data` routes, under `details` when the runtime dispatcher serves it (see
[`VALIDATION_FAILED`](#validation_failed)); on a record write its `constraint` carries
`maxLength` and the `actual` length;
- **a settings write** (a value over its declared maximum) answers `400 SETTINGS_VALIDATION`
with the entry in `details.fields[]`.

**Fix:** Do not branch on this code; branch on `VALIDATION_FAILED` + `fields[].code`
`max_length`, or on `SETTINGS_VALIDATION` + `details.fields[].code` `max_length` for a settings write,
and shorten the value to fit the declared maximum.
**Retry:** `no_retry`

### `VALUE_TOO_SHORT`
**Cause:** String value is below the field's `minLength` constraint.
**Fix:** Provide a longer value that meets the minimum length requirement.
**Cause:** Reserved for a string value shorter than its declared minimum. **No route emits it
today.** A length miss is refused as a *field-level* `min_length` entry instead, and where that
entry rides depends on what was written:

- **a record write** (a string under a field's `minLength`) and **a request body a route parses
with Zod** answer `400 VALIDATION_FAILED` with the entry in `fields[]` — top-level on the
`/data` routes, under `details` when the runtime dispatcher serves it (see
[`VALIDATION_FAILED`](#validation_failed)); on a record write its `constraint` carries
`minLength` and the `actual` length;
- **a settings write** (a value under its declared minimum) answers `400 SETTINGS_VALIDATION`
with the entry in `details.fields[]`.

**Fix:** Do not branch on this code; branch on `VALIDATION_FAILED` + `fields[].code`
`min_length`, or on `SETTINGS_VALIDATION` + `details.fields[].code` `min_length` for a settings write,
and lengthen the value to meet the declared minimum.
**Retry:** `no_retry`

### `VALUE_OUT_OF_RANGE`
Expand Down
Loading