kobotoolbox / kpi / 29898097149

82%

master: 76%

push

github

fix(openapi): type validation error responses as ErrorValidation DEV-1220 (#7275)

### 📣 Summary

The API reference now documents validation errors with their real shape
— a map of field name to error messages — instead of an untyped
placeholder.

### 📖 Description

When a request fails validation, the KoboToolbox API returns each
field's errors as a list of messages. Until now the API reference
described this `400` response as an untyped `detail` object, which
didn't match what the API actually sends. It is now documented
accurately, so anyone building against the API — or relying on the types
generated from its schema — gets the correct shape for validation
errors.

### 💭 Notes

- Renamed the OpenAPI type `ErrorObject` (`{ detail: unknown }`) →
`ErrorValidation` (`Record<string, string[]>`), matching DRF's unwrapped
serializer `ValidationError` payloads (there is no `detail` envelope —
the custom exception handler delegates to stock DRF). A new
`ErrorValidationSerializer` plus a drf-spectacular
`OpenApiSerializerExtension` emit `additionalProperties: string[]`; the
`400` example was flattened to match.
- Regenerated `static/openapi/*` and the orval client. `ServerError` no
longer `implements` the renamed type and the `orval.types.d.ts` `Error`
augmentation for it was dropped — a validation map isn't an `Error`.
- The two list views (`MembersRoute`, `usageProjectBreakdown`) now type
their table error as `ErrorDetail` (their GET hooks never return a
validation map); also fixed a stray `schema-utils` `ErrorObject` import
in `UniversalTable`.
- No runtime behavior change. Gates green: tsc, biome, ruff, darker,
schema generation (no drf-spectacular warnings).

### 👀 Preview steps

1. ℹ️ open the API docs at `/api/v2/docs/` on an endpoint that can
return `400` (e.g. create asset)
2. look at the documented `400 Bad Request` response body and its
example
3. 🔴 [on main] the schema is `ErrorObject` = `{ detail: <unknown> }` and
the example wraps the errors un... (continued)

9464 of 12768 branches covered (74.12%)

8 of 9 new or added lines in 3 files covered. (88.89%)

30671 of 37481 relevant lines covered (81.83%)

5.52 hits per line