[Feature Request] API - List Indicators

[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 listing indicators available in GeoSight and listing the full details of a specific indicator.

Implementation

GET /api/v1/indicators/

• 📒 Description:
  • A paginated list of indicator.
• ⬇️ Parameters:
  • name_contains={string}
  • description_contains={string}
  • shortcode_contains={string}
  • created_by_contains={string}
  • project_slug={project_slug}
  • project_id={project_id}
  • ...
• ⬆️ Returns:
  • results {array}:
    • id
    • name
    • description
    • shortcode
    • type
  • count - number of records
  • page - current page
  • page_count - count of pages
  • next - number of next page
  • previous - number of previous page

GET /api/v1/indicators/{id}/

• 📒 Description:
  • A detailed indicator.
• ⬇️ Parameters:
  • none
• ⬆️ Returns:
  • 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)

[meomancer]

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 to have similiar code like : 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

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