kobotoolbox / kpi / 25166736302

82%

master: 76%

push

github

feat(auth): allauth openapi docs DEV-1829 (#6961)

### 📣 Summary
This PR exposes the django-allauth headless authentication API and
automatically merges its API docs into our core drf-spectacular OpenAPI
schemas. This allows our frontend generators (like Orval) to natively
build TypeScript interfaces for login, MFA, and profile management
flows.

### 📖 Description
I've explicitly mounted `allauth.headless.urls` at `/api/v2/allauth/` so
that Django can successfully perform reverse route-lookups. Since
allauth's engine uses standard Python views instead of DRF ViewSets,
drf-spectacular cannot natively autodiscover them. A custom
postprocessing hook (`merge_allauth_headless_schema`) that fetches the
internal allauth dictionary, ingests all components, and manually
patches them into the final DRF schema payload.

The custom hook automatically flattens ambiguous path templates (like
`_allauth/{client}/v1/login`) into discrete, concrete endpoints
(`/browser/v1/login` and `/app/v1/login`) and automatically injects
unique operationId handles to avoid conflicts with other endpoints
definitions.

### 👀 Preview steps
1. Go to the API docs in your environment (e.g.
http://kf.kobo.local/api/v2/docs/ ) and
2. Check the generated docs under `Authentication (Allauth Headless)`

---------

Co-authored-by: Rebecca Graber <becca.graber@kobotoolbox.org>

9045 of 12165 branches covered (74.35%)

3 of 42 new or added lines in 2 files covered. (7.14%)

29827 of 36342 relevant lines covered (82.07%)

5.77 hits per line