[Feature Request] API - Add Code

[janbur]

This is the child of: https://github.com/unicef-drp/GeoSight-OS/issues/151

Current API docs: https://geosight.unicef.org/api/v1/docs/

Objective

Create a new API endpoint for adding a new Code to GeoSight. This will support batch import of codes and code lists and syncing codes / code lists lists from other platforms (e.g. UNICEF SDMX Data Warehouse: https://sdmx.data.unicef.org/overview.html. Check sample code lists from SDMX Data Warehouse: https://sdmx.data.unicef.org/items/codelist.html

Implementation

POST /api/v1/code-list/{id}/codes

• 📒 Description:
  • Create a code of the code list
• ⬇️ Payloads:
  • name : {unique}
  • description
  • value
• ⬆️ Returns:
  • 201:
    • id
    • name
    • description
    • value
  • 400:
    • response error

[meomancer]

This is part of https://github.com/unicef-drp/GeoSight-OS/issues/160

Technical :

• [ ] Working folder : https://github.com/unicef-drp/GeoSight-OS/tree/main/django_project/geosight/data/api/v1
• [ ] Add url in here : https://github.com/unicef-drp/GeoSight-OS/blob/main/django_project/geosight/data/urls_v1.py
• [ ] Create tests : Put here https://github.com/unicef-drp/GeoSight-OS/tree/main/django_project/geosight/data/tests/api/v1
• [ ] Create the swagger definition, can check data browser API : https://github.com/unicef-drp/GeoSight-OS/blob/main/django_project/geosight/data/api/v1/basemap.py#L34
• [ ] POST 1 data, which is create a new code. should be same with results data structure
• [ ] Restricted just for admin user : Permission_class : https://github.com/unicef-drp/GeoSight-OS/blob/main/django_project/core/permissions.py#L20

Example code:

• API : https://github.com/unicef-drp/GeoSight-OS/blob/main/django_project/geosight/data/api/v1/basemap.py
• Test : https://github.com/unicef-drp/GeoSight-OS/blob/main/django_project/geosight/data/tests/api/v1/basemap.py

[indraneel]

Given that this API endpoint/api/v1/code-list/{id}/codes has /code-list/ in the path, does that mean this issue is dependent on the creation of the code-list endpoint #159?