documentation added for the endpoints

Author: CarlosNasayo

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:

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

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

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

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

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

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

src/api_modules/single_waterpoint_profile.py src/api_modules/waterpoint_profiles.py

@@ -23,15 +23,20 @@ def get(self, waterpoints=None,language=None):
         Get one waterpoint profile from database 
         ---
         description: Query the information of the one waterpoints profile. This endpoint has not parameter.  This endpoint needs two parameters, **waterpoint** that is id of the waterpoint to be queried (this id can be obtained from the endpoint `/waterpoints`), and the **language** that is the language that you want to get; The API will respond with the waterpoit profile with the id provided.
+        tags:
+          - Waterpoint information       
         parameters:
           - in: path
             name: waterpoints
             type: string
             required: true
+            description: IDs of waterpoints you want to retrieve, separated by comma, for example 64d1bf1cc703fe54e05ee7d6,64d1bf1cc703fe54e05ee7d7
           - in: path
             name: language
             type: string
             required: false
+            description: Language in which you want to view the content, currently we have three languages, **en**, **or**, and **am**
+            
         responses:    
           200:
             description: Waterpoints profiles
@@ -104,37 +109,53 @@ def get(self, waterpoints=None,language=None):
                                          content__trace__enable=True)
                 ws_contents = Wscontent.objects(watershed=str(waterpoint.watershed.id), 
                                          content__trace__enable=True)
-                #ws_contents = Wscontent.objects(watershed=str(waterpoint.watershed.id))
-                #contents_list = [content.content for content in wp_contents if 'language' in content.content and content.content['language'] == language]
                 ids=[]
                 typecontent_name=[]
                 for i in wp_contents:
                     ids.append(str(i.type.id))
                     typecontent=Typecontent.objects.get(id=str(i.type.id))
                     typecontent_name.append(typecontent.name)
 
-                print(typecontent_name)
-
-                print(ids)
-                #contents_list = [(content.content) for content in wp_contents if 'language' in content.content and content.content['language'] == language]
-                contents_list = [(content["content"] if "language" not in content["content"]
+                
+                contents_list = [(content["content"] if language not in content["content"]
                   else {**content["content"], "typecontent_id": ids.pop(0)})
                  for content in wp_contents]
 
                 for content, name in zip(contents_list, typecontent_name):
-    # Agregamos el nuevo ID con la clave "id" al contenido existente
                     content["typecontent_name"] = name
 
 
                 for content in contents_list:
                     if 'trace' in content:
                         del content['trace']
 
-                contents_list_ws = [content.content for content in ws_contents if 'language' in content.content and content.content['language'] == language]
+                
+
+                idsws=[]
+                typecontentws_name=[]
+                for i in ws_contents:
+                    idsws.append(str(i.type.id))
+                    typecontent=Typecontent.objects.get(id=str(i.type.id))
+                    typecontentws_name.append(typecontent.name)
+
+                
+                contents_list_ws = [(content["content"] if language not in content["content"]
+                  else {**content["content"], "typecontent_id": idsws.pop(0)})
+                 for content in ws_contents]
+                
+                for content, name in zip(contents_list_ws, typecontentws_name):
+                    content["typecontent_name"] = name
                 for content in contents_list_ws:
                     if 'trace' in content:
                         del content['trace']
-                print(contents_list)
+                filtered_contents=[]
+                for content in contents_list:
+                    if content['language']==language:
+                      filtered_contents.append(content)
+                filtered_contentsws=[]
+                for content in contents_list_ws:
+                    if content['language']==language:
+                      filtered_contentsws.append(content)
                 waterpoint_data = {
                     "id": str(waterpoint.id),
                     "name": waterpoint.name,
@@ -148,8 +169,8 @@ def get(self, waterpoints=None,language=None):
                     "adm3": adm3.name,
                     "adm2": adm2.name,
                     "adm1": adm1.name,
-                    "contents_wp": contents_list,
-                    "contents_ws": contents_list_ws,
+                    "contents_wp": filtered_contents,
+                    "contents_ws": filtered_contentsws,
                 }
 
                 json_data.append(waterpoint_data)

src/tests/test_waterpoint_profile.py

@@ -16,7 +16,7 @@ def tearDown(self):
 
     def test_single_waterpointprofile_valid_id(self):
         # Test a valid waterpointprofile ID
-        response = self.app.get('http://127.0.0.1:5000/api/v1/waterpointsprofiles/en', headers={"Content-Type": "application/json"})
+        response = self.app.get('http://127.0.0.1:5000/api/v1/waterpointsprofiles/64d1bf1cc703fe54e05ee7de/en', headers={"Content-Type": "application/json"})
         self.assertEqual(200, response.status_code)
         # Add more assertions to check the response content
 

src/wpapi.py

@@ -16,36 +16,45 @@
 from api_modules.waterpoint import Waterpoints
 from api_modules.sigle_waterpoint import SingleWaterpoints
 from api_modules.monitored_data import MonitoredData
-from api_modules.single_waterpoint_profile import SingleWaterpointsProfile
+from api_modules.waterpoint_profiles import SingleWaterpointsProfile
 from api_modules.monitored_latest  import LastMonitoredData
 #from api_modules.layers import Layers
 
-
+ 
 app = Flask(__name__)
 CORS(app)
 api = Api(app)
 swagger = Swagger(app)
 
+# Define tus endpoints en el orden deseado
 
-@app.route('/')
+@app.route('/api/v1/home')
 def home():
     return redirect("/apidocs")
 
-
-
+# Endpoint para AdministrativeLevel1
 api.add_resource(AdministrativeLevel1, '/api/v1/adm1')
+
+# Endpoint para AdministrativeLevel2
 api.add_resource(AdministrativeLevel2, '/api/v1/adm2/<adm1>')
+
+# Endpoint para AdministrativeLevel3
 api.add_resource(AdministrativeLevel3, '/api/v1/adm3/<adm2>')
-api.add_resource(Waterpoints, '/api/v1/waterpoints')
-api.add_resource(SingleWaterpoints, '/api/v1/waterpoints/<waterpoint>')
-api.add_resource(MonitoredData, '/api/v1/monitored/<waterpoint>')
-api.add_resource(LastMonitoredData, '/api/v1/lastmonitored/<waterpoint>')
-api.add_resource(SingleWaterpointsProfile, '/api/v1/waterpointsprofiles/<waterpoints>/<language>')
 
+# Endpoint para Waterpoints
+api.add_resource(Waterpoints, '/api/v1/waterpoints')
 
+# Endpoint para SingleWaterpoints
+api.add_resource(SingleWaterpoints, '/api/v1/waterpoints/<waterpoint>')
 
+# Endpoint para MonitoredData
+api.add_resource(MonitoredData, '/api/v1/monitored/<waterpoint>')
 
+# Endpoint para LastMonitoredData
+api.add_resource(LastMonitoredData, '/api/v1/lastmonitored/<waterpoint>')
 
+# Endpoint para SingleWaterpointsProfile
+api.add_resource(SingleWaterpointsProfile, '/api/v1/waterpointsprofiles/<waterpoints>/<language>')
 
 if __name__ == '__main__':
     connect(host=config['CONNECTION_DB'])
@@ -54,6 +63,4 @@ def home():
     if config['DEBUG']:
         app.run(threaded=True, port=config['PORT'], debug=config['DEBUG'])
     else:
-        app.run(host=config['HOST'], port=config['PORT'],
-                debug=config['DEBUG'])
-
+        app.run(host=config['HOST'], port=config['PORT'], debug=config['DEBUG'])