WIP Add descriptions for model comparison endpoints

gyorilab · Jul 11, 2023 · 7c055c2 · 7c055c2
1 parent 536a4e3
commit 7c055c2
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/mira/dkg/model.py b/mira/dkg/model.py
@@ -517,7 +517,11 @@ class ModelComparisonResponse(BaseModel):
 
 @model_blueprint.post("/model_comparison",
                       response_model=ModelComparisonResponse,
-                      tags=["modeling"])
+                      tags=["modeling"],
+                      description="This endpoint consumes a list of "
+                                  "template model JSON objects and returns "
+                                  "similarity scores and the data comparing "
+                                  "the models")
 def model_comparison(
         request: Request,
         query: ModelComparisonQuery
@@ -545,7 +549,10 @@ class AMRComparisonQuery(BaseModel):
 @model_blueprint.post("/askenet_model_comparison",
                       response_model=ModelComparisonResponse,
                       tags=["modeling"],
-                      description="")
+                      description="This endpoint consumes a list of askenet "
+                                  "petrinet JSON objects and returns "
+                                  "similarity scores and the data comparing "
+                                  "the models")
 def askepetrinet_model_comparison(
         request: Request,
         query: AMRComparisonQuery