#22: add documentation for the validation method

IN-CORE · Oct 21, 2021 · c40ac7d · c40ac7d
1 parent a6e0809
commit c40ac7d
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/server/incore-common/src/main/java/edu/illinois/ncsa/incore/common/utils/UserInfoUtils.java b/server/incore-common/src/main/java/edu/illinois/ncsa/incore/common/utils/UserInfoUtils.java
@@ -31,6 +31,12 @@ public static String getUsername(String userInfo) {
         }
     }
 
+    /***
+     * Checks if a field "id" exists in the object created from the Json. This will be used to validate the incoming json in POST API calls.
+     * If present, it should reject the API call because new ids are created by MongoDB, and user shouldn't update the document through a
+     * POST call.
+     * @param id
+     */
     public static void throwExceptionIfIdPresent(String id){
         if(id != null){
             throw new IncoreHTTPException(Response.Status.BAD_REQUEST, "Ids are auto-generated by the system. " +