-
- Downloads
feat: add schema documentation with drf-spectacular
This adds extensive API documentation based on the official API documentation [1] and conflict resolution [2] documents. Where possible field documentation was added to models or serializers, so that other code like auto-generated forms can also profit from these changes (hence the migration part of this commit). The changes introduce two new API endpoints. `/api/v1/schema/` exposes the API schema as an OpenAPI 3.0.3 document. The standard format is yaml but can be switched to JSON by appending the `?format=json` query parameter. `/api/v1/schema/swagger-ui/` renders a visual representation of the OpenAPI 3 specification with support for testing the individual API endpoints including authentication. [1] https://gitlab.servus.at/aura/meta/-/blob/ec3c753d34ccb0269969808ac7dc28fff2ff1648/docs/development/api-definition.md [2] https://gitlab.servus.at/aura/meta/-/blob/ec3c753d34ccb0269969808ac7dc28fff2ff1648/docs/development/conflict-resolution.md
parent
673ee6d7
No related branches found
No related tags found
Showing
- program/auth.py 26 additions, 0 deletionsprogram/auth.py
- program/filters.py 2 additions, 1 deletionprogram/filters.py
- program/migrations/0018_auto_20220322_2113.py 103 additions, 0 deletionsprogram/migrations/0018_auto_20220322_2113.py
- program/models.py 71 additions, 11 deletionsprogram/models.py
- program/serializers.py 157 additions, 13 deletionsprogram/serializers.py
- program/views.py 236 additions, 87 deletionsprogram/views.py
- requirements.txt 1 addition, 0 deletionsrequirements.txt
- steering/schema.py 59 additions, 0 deletionssteering/schema.py
- steering/settings.py 13 additions, 0 deletionssteering/settings.py
- steering/urls.py 7 additions, 0 deletionssteering/urls.py
Loading
Please register or sign in to comment