clean code and documentation

Author: ishaileshmishra

.github/workflows/publish.yml

@@ -13,8 +13,8 @@ jobs:
       - name: Set up Java for publishing to Maven Central Repository
         uses: actions/setup-java@v3
         with:
-          java-version: '11'
-          distribution: 'adopt'
+          java-version: "11"
+          distribution: "adopt"
           server-id: ossrh
           server-username: ${{ secrets.OSSRH_USERNAME }}
           server-password: ${{ secrets.OSSRH_PASSWORD }}
@@ -37,5 +37,5 @@ jobs:
       - name: Set up Java for publishing to GitHub Packages
         uses: actions/setup-java@v3
         with:
-          java-version: '11'
-          distribution: 'adopt'
+          java-version: "11"
+          distribution: "adopt"

src/main/java/com/contentstack/cms/Parametron.java

@@ -3,6 +3,7 @@
 import org.jetbrains.annotations.NotNull;
 
 import java.util.HashMap;
+import java.util.Map;
 
 /**
  * The interface Parametron.

src/main/java/com/contentstack/cms/marketplace/apps/App.java

@@ -117,7 +117,7 @@ public App addHeader(@NotNull String key, @NotNull String value) {
      */
     @SuppressWarnings("unchecked")
     @Override
-    public App addParams(@NotNull HashMap params) {
+    public App addParams(@NotNull HashMap  params) {
         this.params.putAll(params);
         return this;
     }

src/main/java/com/contentstack/cms/marketplace/installations/webhook/Webhook.java

@@ -83,7 +83,7 @@ public Call<ResponseBody> fetchExecutionLogs(String executionId) {
      *                    unique identifier of an
      *                    execution. It is used to identify a specific execution
      *                    that needs to be retried.
-     * @return The method is returning a `Call<ResponseBody>` object.
+     * @return Call object.
      */
     public Call<ResponseBody> retryExecution(@NotNull String executionId) {
         validateInstallationId();

src/main/java/com/contentstack/cms/marketplace/package-info.java

@@ -1,4 +1,4 @@
 /**
- * Useful to access contentstack's app components
+ * Useful to access contentstack's app/manifest components
  */
 package com.contentstack.cms.marketplace;

src/main/java/com/contentstack/cms/marketplace/request/package-info.java

@@ -1,4 +1,4 @@
 /**
- * Useful to access contentstack's app components
+ * Useful to access contentstack's app request components
  */
 package com.contentstack.cms.marketplace.request;

src/main/java/com/contentstack/cms/organization/package-info.java

@@ -1,4 +1,4 @@
 /**
- * Useful to access contentstack's organizations
+ * Useful to access contentstack's organization component
  */
 package com.contentstack.cms.organization;

src/main/java/com/contentstack/cms/stack/Stack.java

@@ -39,58 +39,66 @@ public Stack(@NotNull Retrofit client) {
     }
 
     /**
-     * Sets header for the request
-     *
-     * @param key
-     *              header key for the request
-     * @param value
-     *              header value for the request
+     * The addHeader function adds a key-value pair to the headers map and returns
+     * the updated Stack
+     * object.
+     * 
+     * @param key   A string representing the key of the header. It is marked
+     *              as @NotNull, which means it
+     *              cannot be null and must be provided.
+     * @param value The value parameter is of type Object, which means it can accept
+     *              any type of object as
+     *              its value.
+     * @return The method is returning a Stack object.
      */
     public Stack addHeader(@NotNull String key, @NotNull Object value) {
         this.headers.put(key, value);
         return this;
     }
 
     /**
-     * Sets header for the request
-     *
-     * @param key
-     *              header key for the request
-     * @param value
-     *              header value for the request
+     * The addParam function adds a key-value pair to a stack and returns the
+     * updated stack.
+     * 
+     * @param key   A string representing the key for the parameter.
+     * @param value The value parameter is of type Object, which means it can accept
+     *              any type of object as
+     *              its value.
+     * @return The method is returning a reference to the current instance of the
+     *         Stack object.
      */
     public Stack addParam(@NotNull String key, @NotNull Object value) {
         this.params.put(key, value);
         return this;
     }
 
     /**
-     * Sets header for the request
-     *
-     * @param key
-     *            header key for the request
+     * The function removes a parameter from a stack and returns the modified stack.
+     * 
+     * @param key The parameter "key" is of type String and is marked with
+     *            the @NotNull annotation,
+     *            indicating that it cannot be null.
+     * @return The method is returning a Stack object.
      */
     public Stack removeParam(@NotNull String key) {
         this.params.remove(key);
         return this;
     }
 
     /**
-     * To clear all the query params
+     * The function clears the parameters in a stack and returns the modified stack.
+     * 
+     * @return The method is returning a reference to the current instance of the
+     *         Stack object.
      */
     protected Stack clearParams() {
         this.params.clear();
         return this;
     }
 
-    /**
-     * Instantiates a new Stack.
-     *
-     * @param client
-     *                the contentstack client
-     * @param headers
-     *                Required headers to get the {@link Stack} information
-     */
+    // The above code is defining a constructor for a class called "Stack". The
+    // constructor takes two
+    // parameters: a Retrofit client and a map of headers.
     public Stack(@NotNull Retrofit client, @NotNull Map<String, Object> headers) {
         this.headers = new HashMap<>();
         this.client = client;

src/test/java/com/contentstack/cms/Utils.java

@@ -1,10 +1,7 @@
 package com.contentstack.cms;
 
-import com.contentstack.cms.core.Util;
-import com.contentstack.cms.stack.Stack;
 import com.google.gson.Gson;
 import com.google.gson.JsonObject;
-import io.github.cdimascio.dotenv.Dotenv;
 import okhttp3.ResponseBody;
 import org.json.simple.JSONObject;
 import org.json.simple.parser.JSONParser;
@@ -14,26 +11,22 @@
 import java.io.File;
 import java.io.FileReader;
 import java.io.IOException;
-import java.util.HashMap;
 import java.util.logging.Logger;
 
 public class Utils {
 
-
     private final static Logger log = Logger.getLogger(Utils.class.getName());
 
-
     public static JsonObject toJson(Response<ResponseBody> response) throws IOException {
         assert response.body() != null;
         return new Gson().fromJson(response.body().string(), JsonObject.class);
     }
 
-
     /**
      * This is used to convert json sting to the JSONObject
      *
      * @param jsonString
-     *         the json sting you want to convert as JSONObject
+     *                   the json sting you want to convert as JSONObject
      * @return JSONObject the request body
      */
     public static JSONObject createJSONObject(String jsonString) {
@@ -50,11 +43,13 @@ public static JSONObject createJSONObject(String jsonString) {
     }
 
     /**
-     * This is used to read json file from the local machine. We are referring the files from the project's resource
+     * This is used to read json file from the local machine. We are referring the
+     * files from the project's resource
      * itself 'String path = "src/test/resources/" + file;'
      *
      * @param file
-     *         The file is the path of type string from where JSON File has to read
+     *             The file is the path of type string from where JSON File has to
+     *             read
      * @return JSONObject the request body
      */
 

src/test/java/com/contentstack/cms/user/UserMockTests.java

@@ -79,7 +79,7 @@ void test_mock_testcase_update_user() {
         mockJsonObject = Utils.readJson("mockuser/updateuser.json");
         Assertions.assertEquals("Profile updated successfully.", mockJsonObject.get("notice"));
         mockJsonObject = (JSONObject) mockJsonObject.get("user");
-        Set allKeys = mockJsonObject.keySet();
+        Set<String> allKeys = mockJsonObject.keySet();
         logger.finest(mockJsonObject.toJSONString());
         String[] keyArray = {
                 "org_uid",