[Feature Request] API - Add Indicator

[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 indicator to GeoSight. This will support batch import of indicators e.g. from another platform or another GeoSight instance.

Implementation

POST /api/v1/indicators/

• 📒 Description:

  • Create an indicator.

• ⬇️ Payload:

  • name (string),
  • description (string),
  • source (string),
  • short_code (string),
  • category (string),
  • units (string),
  • type (int, float, category),
  • value_min (for int and float types),
  • value_max (for int and float types),
  • code_list_id (for "category" type only)

• ⬆️ Returns:

  • 201:
    • name (string),
    • description (string),
    • source (string),
    • short_code (string),
    • category (string),
    • units (string),
    • type (int, float, category),
    • value_min (for int and float types),
    • value_max (for int and float types),
    • code_list_id (for "category" type only)
  • 400:
    • response error

PUT /api/v1/indicators/{id}/

• 📒 Description:
  • Update an indicator.
• ⬇️ Payload:
  • name (string),
  • description (string),
  • source (string),
  • short_code (string),
  • category (string),
  • units (string),
  • type (int, float, category),
  • value_min (for int and float types),
  • value_max (for int and float types),
  • code_list_id (for "category" type only)
• ⬆️ Returns:
  • 201:
    • name (string),
    • description (string),
    • source (string),
    • short_code (string),
    • category (string),
    • units (string),
    • type (int, float, category),
    • value_min (for int and float types),
    • value_max (for int and float types),
    • code_list_id (for "category" type only)
  • 400:
    • response error

[meomancer]

This is partial of #160

Technical :

• A quick code is already there, update it : https://github.com/unicef-drp/GeoSight-OS/blob/main/django_project/geosight/data/api/v1/indicator.py
• Update it similiar with basemap API : https://github.com/unicef-drp/GeoSight-OS/blob/main/django_project/geosight/data/api/v1/basemap.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.
• PUT /api/v1/code-list/{id} is basically edit an indicator. should be same with results data structure.
• Can check the code in the platform : https://github.com/unicef-drp/GeoSight-OS/blob/main/django_project/frontend/views/admin/indicator/create.py#L152

        form = IndicatorForm(data)
        if form.is_valid():
            instance = form.instance
            instance.creator = request.user
            instance.save()

• Change form like : https://github.com/unicef-drp/GeoSight-OS/blob/main/django_project/geosight/data/forms/basemap.py#L77
• Exclude group field and change it as category. In payload, it is category, in the model it is group.
• Add validation, if type is category, codelist should be not None

Reference 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