kobotoolbox / kpi / 26242541573

82%

master: 76%

Build Type

push

github

Committed by web-flow

Commit Message

fix(languages): correct Orval-generated types for language services fields and LanguagesListParams DEV-2142 DEV-2143 (#7067)

### 📣 Summary
This PR corrects two OpenAPI schema inaccuracies in the language
endpoints that caused incorrect Orval-generated TypeScript types for the
frontend.

### 📖 Description
This PR addresses two schema issues reported by the frontend against the
language API endpoints.

**Issue 1: Incorrect schema for `transcription_services` /
`translation_services` on the retrieve endpoint**

The list (`/api/v2/languages/`) and retrieve
(`/api/v2/languages/{code}/`) endpoints return different shapes for the
services fields, but both serializers were annotated with the same
`@extend_schema_field(ServicesField)`, causing drf-spectacular to emit
one schema for both, which matched only the list endpoint. This led
Orval to generate an incorrect array type for the retrieve endpoint's
response.

This is resolved by introducing a dedicated `ServicesDetailField` marker
class and a corresponding `ServicesDetailFieldExtension` that emits the
correct nested-object schema (`{ [serviceCode]: { [regionCode]: string }
}`).

`LanguageSerializer` (retrieve) is updated to use `ServicesDetailField`,
while `LanguageListSerializer` (list) continues to use the existing
`ServicesField`.

**Issue 2: Missing `q` query parameter in `LanguagesListParams`**

The `LanguageViewSet` relied on `BaseViewSet`'s `SearchFilter` backend
to handle the `q` parameter at runtime, but drf-spectacular requires
explicit `OpenApiParameter` declarations to include query params in the
schema. As a result, `q` was absent from the generated
`LanguagesListParams` type, forcing the frontend to cast hook calls with
`as any`. This is resolved by adding an explicit
`OpenApiParameter(name='q', ...)` declaration to the `list` action
schema, consistent with the pattern already used in
`TranscriptionServiceViewSet`.

Coverage Stats

9239 of 12471 branches covered (74.08%)

10 of 11 new or added lines in 4 files covered. (90.91%)

3101 existing lines in 94 files now uncovered.

30551 of 37241 relevant lines covered (82.04%)

5.73 hits per line