[Feature Request] API - List Codes

[janbur]

This is the child of: #151

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

Objective

Create a new API endpoint for listing codes available in GeoSight. Codes are used to build code lists, used for category-based indicators and define allowed values (categories) as indicator values. E.g. the type of indicator A is Category, it is associated with a code list Low-Medium-High. The code list consists of the following codes: Low, Medium, High. These will be the only allowed observation values for indicator A.

Implementation

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

• 📒 Description:
  • A paginated list of code.
• ⬇️ Parameters:
  • name_contains={string}
• ⬆️ Returns:
  • results {array}:
    • id
    • name
    • description
    • value
  • count - number of records
  • page - current page
  • page_count - count of pages
  • next - number of next page
  • previous - number of previous page

[meomancer]

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
• Can check API example here : https://github.com/unicef-drp/GeoSight-OS/blob/main/django_project/geosight/data/api/v1/indicator.py#L26
• 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