Merge pull request #9 from CIAT-DAPA/develop

Develop
CIAT-DAPA · Sep 18, 2023 · 1384915 · 1384915
2 parents 2273f8b + a4c7d8c
commit 1384915
Show file tree

Hide file tree

Showing 15 changed files with 223 additions and 373 deletions.
diff --git a/src/.gitignore b/src/.gitignore
@@ -131,13 +131,14 @@ celerybeat.pid
 
 # Environments
 .venv
-env/
+/env/
 venv/
 ENV/
 env.bak/
 venv.bak/
 /env/
 ./env
+/env
 
 # Spyder project settings
 .spyderproject

diff --git a/src/api_modules/adm1.py b/src/api_modules/adm1.py
@@ -13,9 +13,12 @@ def get(self):
         Get all Administrative levels 1 from database (zone)
         ---
         description: Query the information of all administrative levels 1 and the API will respond with the list of all regions, this endpoint has no parameters.
+        tags:
+          - Administrative levels
         responses:
           200:
             description: Administrative level 1
+            
             schema:
               id: Adm1
               properties:

diff --git a/src/api_modules/adm2.py b/src/api_modules/adm2.py
@@ -13,11 +13,14 @@ def get(self, adm1 = None):
         Get all Administrative levels 2 from database (woreda)
         ---
         description: Query the information of the administrative levels 2 (woreda). This endpoint needs one parameter, **adm1** that is id of the administrative levels 1 (zone) to be queried (this id can be obtained from the endpoint `/adm1`); The API will respond with the list of the woredas from that specific zone.
+        tags:
+          - Administrative levels
         parameters:
           - in: path
             name: adm1
             type: string
             required: true
+            description: adm1 id to be query, for example 64d1be9c16bfd546aec4f58b
         responses:
           200:
             description: Administrative levels 2

diff --git a/src/api_modules/adm3.py b/src/api_modules/adm3.py
@@ -13,11 +13,14 @@ def get(self,adm2=None):
         Get all Administrative levels 3 from database (kebele)
         ---
         description: Query the information of the administrative levels 3 (kebele). This endpoint needs one parameter, **adm2** that is id of the administrative levels 2 (woreda) to be queried (this id can be obtained from the endpoint `/adm2`); The API will respond with the list of the kebeles from that specific woreda.
+        tags:
+          - Administrative levels
         parameters:
           - in: path
             name: adm2
             type: string
             required: true
+            description: adm2 id to be query, for example 64d1bec4f8b9461ac6ed74cb
         responses:    
           200:
             description: Administrative levels 3

diff --git a/src/api_modules/monitored_data.py b/src/api_modules/monitored_data.py
@@ -12,11 +12,14 @@ def get(self, waterpoint=None):
         Get all Monitored data
         ---
         description: Query the information of monitored data from one waterpoint . This endpoint needs one parameter, **waterpoint** that is id of the waterpoint to be queried (this id can be obtained from the endpoint `/waterpoint`); The API will respond with the list of the monitored values from that specific waterpoint.
+        tags:
+          - Waterpoint Monitored data
         parameters:
           - in: path
             name: waterpoint
             type: string
             required: true
+            description: waterpoint id to be query, for example 64d1bf1cc703fe54e05ee7d6
         responses:
           200:
             description: Monitored data

diff --git a/src/api_modules/monitored_latest.py b/src/api_modules/monitored_latest.py
@@ -12,11 +12,14 @@ def get(self, waterpoint=None):
         Get last Monitored data
         ---
         description: Query the information of last monitored data from one waterpoint . This endpoint needs one parameter, **waterpoint** that is id of the waterpoint to be queried (this id can be obtained from the endpoint `/waterpoint`); The API will respond with the list of the last monitored values from that specific waterpoint.
+        tags:
+          - Waterpoint Monitored data
         parameters:
           - in: path
             name: waterpoint
             type: string
             required: true
+            description: waterpoint id to be query, for example 64d1bf1cc703fe54e05ee7d6
         responses:
           200:
             description: Monitored data

diff --git a/src/api_modules/sigle_waterpoint.py b/src/api_modules/sigle_waterpoint.py
@@ -13,11 +13,14 @@ def get(self,waterpoint=None):
         Get all one waterpoint from database 
         ---
         description: Query the information of the ons specific waterpoint. This endpoint needs one parameter, **waterpoint** that is id of the waterpoint to be queried (this id can be obtained from the endpoint `/waterpoints`); The API will respond with the waterpoit with the id provided.
+        tags:
+          - Waterpoint information
         parameters:
           - in: path
             name: waterpoint
             type: string
             required: true
+            description: waterpoint id to be query, for example 64d1bf1cc703fe54e05ee7d6
         responses:    
           200:
             description: Waterpoint

diff --git a/src/api_modules/single_waterpoint_profile.py b/src/api_modules/single_waterpoint_profile.py
diff --git a/src/api_modules/warterpoint_profile.py b/src/api_modules/warterpoint_profile.py
diff --git a/src/api_modules/waterpoint.py b/src/api_modules/waterpoint.py
@@ -13,6 +13,8 @@ def get(self):
         Get all waterpoints  from database 
         ---
         description: Query the information of the waterpoints. This endpoint has not parameter.
+        tags:
+          - Waterpoint information
         responses:    
           200:
             description: Waterpoints