Add 400 to the openapi doc and fix typo

maproulette · Dec 19, 2023 · 49c4825 · 49c4825
1 parent 56d0200
commit 49c4825
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/app/org/maproulette/framework/controller/CommentController.scala b/app/org/maproulette/framework/controller/CommentController.scala
@@ -141,7 +141,7 @@ class CommentController @Inject() (
             // "comment" field is missing in the request body
             BadRequest(
               Json.toJson(
-                StatusMessage("KO", JsString("Required comment object in request body no found."))
+                StatusMessage("KO", JsString("Required comment object in request body not found."))
               )
             )
         }
@@ -179,7 +179,7 @@ class CommentController @Inject() (
             // "comment" field is missing in the request body
             BadRequest(
               Json.toJson(
-                StatusMessage("KO", JsString("Required comment object in request body no found."))
+                StatusMessage("KO", JsString("Required comment object in request body not found."))
               )
             )
         }
@@ -255,7 +255,7 @@ class CommentController @Inject() (
             // "comment" field is missing in the request body
             BadRequest(
               Json.toJson(
-                StatusMessage("KO", JsString("Required comment object in request body no found."))
+                StatusMessage("KO", JsString("Required comment object in request body not found."))
               )
             )
         }

diff --git a/conf/v2_route/comment.api b/conf/v2_route/comment.api
@@ -91,6 +91,8 @@ GET     /challengeComments/user/:id                          @org.maproulette.fr
 #       application/json:
 #         schema:
 #           $ref: '#/components/schemas/org.maproulette.framework.model.Comment'
+#   '400':
+#     description: If the request lacks the comment or the comment is empty
 #   '404':
 #     description: If the Task is not found
 # parameters:
@@ -127,6 +129,8 @@ POST    /task/:id/comment                           @org.maproulette.framework.c
 #       application/json:
 #         schema:
 #           $ref: '#/components/schemas/TaskBundle'
+#   '400':
+#     description: If the request lacks the comment or the comment is empty
 #   '404':
 #     description: If the bundle is not found
 # parameters:
@@ -163,6 +167,8 @@ POST    /taskBundle/:id/comment                     @org.maproulette.framework.c
 #       application/json:
 #         schema:
 #           $ref: '#/components/schemas/org.maproulette.framework.model.Comment'
+#   '400':
+#     description: If the request lacks the comment or the comment is empty
 #   '401':
 #     description: If the user is not the original user who made the comment or a super user
 #   '404':
@@ -216,6 +222,8 @@ DELETE  /task/:id/comment/:commentId                @org.maproulette.framework.c
 #       application/json:
 #         schema:
 #           $ref: '#/components/schemas/org.maproulette.framework.model.ChallengeComment'
+#   '400':
+#     description: If the request lacks the comment or the comment is empty
 #   '404':
 #     description: If the Challenge is not found
 # parameters: