[Feature Request] API - Add Code list

[janbur]

This is the child of: #151

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

Objective

Create a new API endpoint for adding a new Code Lists to GeoSight. This will support batch import of code lists and syncing code 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/

• 📒 Description:

  • Create an code list.

• ⬇️ Payloads:

  • name
  • description
  • codes {Array}
    • id
    • name
    • value

• ⬆️ Returns:

  • 201:
    • name
    • description
    • codes {Array}:
      • id
      • name
      • value
  • 400:
    • response error

PUT /api/v1/code-list/{id}

• 📒 Description:
  • Update an code list
• ⬇️ Payloads:
  • id
  • name
  • description
  • codes {Array}: {Optional, when empty, it will not replace the codes. If not empty, replace codes.}
    • id
    • name
    • value
• ⬆️ Returns:
  • 200:
    • id
    • name
    • description
    • codes {Array}:
      • id
      • name
      • value

[meomancer]

This is partial of #158
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 /api/v1/code-list/ should be just 1 data. should be same with results data structure. It is create new code list, as well as create new codes under it.
• PUT /api/v1/code-list/{id} is basically edit the code-list. should be same with results data structure. Replace all of codes under this code list (if codes key is provided).
• 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