kobotoolbox / kpi / 26152690191

82%

master: 76%

Build Type

push

github

Committed by web-flow

Commit Message

feat(auth): environment internal endpoint openapi docs DEV-2014 (#6978)

### 📣 Summary
Added `/environment` endpoint to the OpenAPI docs 

### 📖 Description
Created EnvironmentResponseSerializer (along with SocialAppSerializer
and MetadataFieldSerializer) to explicitly type out all configuration
properties. Added markdown documentation describing what the endpoint
provides. The view get() method was then decorated with @extend_schema
to formally document the endpoint using Kobo's standardized
open_api_200_ok_response format, and added APIV2Versioning so the V2
schema generator picks it up.

### 👀 Preview steps
Go to the API docs and review the generated docs
`http://kf.kobo.local/api/v2/docs/` in the `Configuration` section

---------

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

Coverage Stats

9237 of 12470 branches covered (74.07%)

55 of 55 new or added lines in 2 files covered. (100.0%)

1824 existing lines in 95 files now uncovered.

30544 of 37234 relevant lines covered (82.03%)

5.73 hits per line