❇️ api documentation

Author: ishaileshmishra

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

@@ -46,37 +46,36 @@ protected Asset(Retrofit instance, @NotNull Map<String, Object> stackHeaders) {
      * @param query
      *         query params for the assets older(optional) Enter either the UID of a specific folder to get the assets
      *         of that folder, or enter ‘cs_root’ to get all assets and their folder details from the root folder.
-     *         <p>
+     *
      *         <p>
      *         include_folders(optional) Set this parameter to ‘true’ to include the details of the created folders
      *         along with the details of the assets.
-     *         <p>
+     *
      *         <p>
      *         environment(optional) Enter the name of the environment to retrieve the assets published on them. You can
      *         enter multiple environments.
-     *         <p>
+     *
      *         <p>
      *         version(optional) Specify the version number of the asset that you want to retrieve. If the version is
      *         not specified, the details of the latest version will be retrieved.
      *         <p>
-     *         <p>
      *         include_publish_details(optional) Enter 'true' to include the publishing details of the entry.
-     *         <p>
+     *
      *         <p>
      *         include_count(optional) Set this parameter to 'true' to include the total number of assets available in
      *         your stack in the response body.
-     *         <p>
+     *
      *         <p>
      *         relative_urls(optional) Set this to 'true' to display the relative URL of the asset.
-     *         <p>
+     *
      *         <p>
      *         asc_field_uid(optional) Enter the unique ID of the field for sorting the assets in ascending order by
      *         that field. Example:created_at
-     *         <p>
+     *
      *         <p>
      *         desc_field_uid(optional) Enter the unique ID of the field for sorting the assets in descending order by
      *         that field.
-     *         <p>
+     *
      *         <p>
      *         Example:file_size
      * @return the retrofit2.Call
@@ -142,6 +141,8 @@ public Call<ResponseBody> subfolder(
      * To upload assets from your local system to Contentstack and manage their details, you need to use the following
      * "form-data" parameters:
      *
+     * @param filePath
+     *         the file path
      * @param requestBody
      *         Request body for the asset file
      *         <p>
@@ -284,6 +285,8 @@ public Call<ResponseBody> rteInformation() {
      *         asset uid
      * @param versionNumber
      *         asset version number
+     * @param requestBody
+     *         the request body of {@link JSONObject}
      * @return the retrofit2.Call
      */
     public Call<ResponseBody> setVersionName(@NotNull String assetUid, int versionNumber,

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

@@ -267,10 +267,12 @@ public Call<ResponseBody> delete(@NotNull String contentTypeUid,
      *
      * @param contentTypeUid
      *         the content type uid
+     * @param isIncludeGlobalField
+     *         Include Global Field true/false
      * @return the call
      */
-    public Call<ResponseBody> reference(@NotNull String contentTypeUid, Boolean includeGlobalField) {
-        return service.reference(contentTypeUid, this.headers, includeGlobalField);
+    public Call<ResponseBody> reference(@NotNull String contentTypeUid, Boolean isIncludeGlobalField) {
+        return service.reference(contentTypeUid, this.headers, isIncludeGlobalField);
     }
 
     /**

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

@@ -37,7 +37,7 @@ protected Environment(Retrofit instance, @NotNull Map<String, Object> stackHeade
      *
      * @param query
      *         query parameter
-     * @return Call<ResponseBody>
+     * @return Call
      */
     public Call<ResponseBody> fetch(Map<String, Object> query) {
         if (query == null) {
@@ -55,7 +55,7 @@ public Call<ResponseBody> fetch(Map<String, Object> query) {
      *
      * @param environment
      *         name of the environment
-     * @return Call<ResponseBody>
+     * @return Call
      */
     public Call<ResponseBody> get(@NotNull String environment) {
         return this.service.getEnv(this.headers, environment);
@@ -73,7 +73,7 @@ public Call<ResponseBody> get(@NotNull String environment) {
      *
      * @param requestBody
      *         request body of type @{@link JSONObject}
-     * @return Call<ResponseBody>
+     * @return Call
      */
     public Call<ResponseBody> add(@NotNull JSONObject requestBody) {
         return this.service.add(this.headers, requestBody);
@@ -94,7 +94,7 @@ public Call<ResponseBody> add(@NotNull JSONObject requestBody) {
      *         name of the environment
      * @param requestBody
      *         request body of type @{@link JSONObject}
-     * @return Call<ResponseBody>
+     * @return Call
      */
     public Call<ResponseBody> update(@NotNull String environmentName, @NotNull JSONObject requestBody) {
         return this.service.update(this.headers, environmentName, requestBody);
@@ -109,7 +109,7 @@ public Call<ResponseBody> update(@NotNull String environmentName, @NotNull JSONO
      *
      * @param environmentName
      *         name of the environment
-     * @return Call<ResponseBody>
+     * @return Call
      */
     public Call<ResponseBody> delete(@NotNull String environmentName) {
         return this.service.delete(this.headers, environmentName);

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

@@ -19,8 +19,7 @@
  * <p>
  * You can now pass the branch header in the API request to fetch or manage modules located within specific branches of
  * the stack. Additionally, you can also set the include_branch query parameter to true to include the _branch top-level
- * key in the response.
- * This key specifies the unique ID of the branch where the concerned Contentstack module resides.
+ * key in the response. This key specifies the unique ID of the branch where the concerned Contentstack module resides.
  *
  * @author ***REMOVED***
  * @version 1.0.0
@@ -58,7 +57,7 @@ public Extensions addParam(@NotNull String key, @NotNull String value) {
      *         Set this to 'true' to include the '_branch' top-level key in the response. This key states the unique ID
      *         of the branch where the concerned Contentstack module resides.
      *         <b>Example:false</b>
-     * @return @{@link Call}
+     * @return Call
      */
     public Call<ResponseBody> getAll(@NotNull String query, boolean isIncludeBranch) {
         return this.service.getAll(this.headers, query, isIncludeBranch);
@@ -97,16 +96,12 @@ public Call<ResponseBody> get(@NotNull String customFieldUid, Map<String, Object
      *         of the branch where the concerned Contentstack module resides.
      *         <p>
      *         <b>Example:false</b>
-     * @param body
-     *         In the ‘Body’ section, you need to provide the following ‘Body’ parameters under ‘form-data’
-     *         <pre>
-     *                                                 Use like: Map<String, RequestBody> params = new HashMap<>();
-     *                                                 prepare RequestBody RequestBody someDataBody = ....;
-     *                                                 add it Map object params.put("DYNAMIC_PARAM_NAME", someDataBody);
-     *                                                 </pre>
+     * @param body the request body
+     *
      * @return Call
      */
     public Call<ResponseBody> uploadCustomField(Map<String, RequestBody> body, Map<String, Object> queryParam) {
+        //TODO: Could be improved:
         if (queryParam == null) {
             queryParam = new HashMap<>();
         }
@@ -129,12 +124,7 @@ public Call<ResponseBody> uploadCustomField(Map<String, RequestBody> body, Map<S
      *         <p>
      *         <b>Example:false</b>
      * @param body
-     *         In the ‘Body’ section, you need to provide the following ‘Body’ parameters under ‘form-data’
-     *         <pre>
-     *                                                                                                                                                                                         Use like: Map<String, RequestBody> params = new HashMap<>();
-     *                                                                                                                                                                                         //prepare RequestBody RequestBody someDataBody = ....;
-     *                                                                                                                                                                                         //add it Map object params.put("DYNAMIC_PARAM_NAME", someDataBody);
-     *                                                                                                                                                                                  </pre>
+     *         the request body
      * @return Call
      */
     public Call<ResponseBody> uploadCustomField(Map<String, Object> queryParam, JSONObject body) {

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

@@ -86,6 +86,8 @@ public Call<ResponseBody> get() {
      * <p>
      * To learn more about the queries, refer to the Query section of the Content Delivery API doc.
      *
+     * @param jsonRequest
+     *         request parameters
      * @return Call
      */
     public Call<ResponseBody> get(@NotNull Map<String, Object> jsonRequest) {
@@ -143,6 +145,7 @@ public Call<ResponseBody> add(@NotNull JSONObject requestBody) {
      *
      * @param labelUid
      *         the label uid
+     * @param body request body
      * @return Call
      */
     public Call<ResponseBody> update(@NotNull String labelUid, @NotNull JSONObject body) {

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

@@ -114,7 +114,9 @@ public Call<ResponseBody> updateLocale(@NotNull String code, @NotNull JSONObject
      * <p>
      * Fallback Languages
      *
-     * @return the retrofit2.Call
+     * @param localeCode
+     *         locale code you want to delete
+     * @return Call
      */
     public Call<ResponseBody> deleteLocale(String localeCode) {
         return localeService.deleteLocale(this.headers, localeCode);

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

@@ -104,8 +104,8 @@ public Asset asset() {
 
     /**
      * An entry is the actual piece of content created using one of the defined
-     *
-     * @return {@link Entry} Entry instance
+     * @param contentTypeUid content type uid for the entry
+     * @return Entry instance
      * @see <a href="https://www.contentstack.com/docs/developers/create-content-types/about-content-types">Content
      * Type</a>
      */
@@ -117,6 +117,8 @@ public Entry entry(@NotNull String contentTypeUid) {
      * A Global field is a reusable field (or group of fields) that you can define once and reuse in any content type
      * within your stack. This eliminates the need (and thereby time and efforts) to create the same set of fields
      * repeatedly in multiple content types.
+     *
+     * @return GlobalField
      */
     public GlobalField globalField() {
         return new GlobalField(this.client, this.headers);
@@ -155,16 +157,12 @@ public Environment environment() {
      * Labels allow you to group a collection of content within a stack. Using labels you can group content types that
      * need to work together. Read more about
      *
-     * @return @{@link Label}
-     * <p>
-     * @see <a href="https://www.contentstack.com/docs/developers/create-content-types/manage-labels">Labels</a>
+     * @return Label
      *
-     * <p>
      * You can now pass the branch header in the API request to fetch or manage modules located within specific branches
      * of the stack. Additionally, you can also set the include_branch query parameter to true to include the _branch
      * top-level key in the response. This key specifies the unique ID of the branch where the concerned Contentstack
      * module resides.
-     * <p>
      */
     public Label label() {
         return new Label(this.client, this.headers);

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

@@ -52,7 +52,7 @@ public Tokens addHeader(@NotNull String key, @NotNull String value) {
     /**
      * The Get all delivery tokens request returns the details of all the delivery tokens created in a stack.
      *
-     * @return Call<ResponseBody>
+     * @return Call
      */
     public Call<ResponseBody> getDeliveryTokens() {
         return this.service.getDeliveryToken(this.headers);
@@ -63,7 +63,7 @@ public Call<ResponseBody> getDeliveryTokens() {
      *
      * @param tokenUid
      *         the UID of the token that you want to retrieve
-     * @return Call<ResponseBody>
+     * @return Call
      */
     public Call<ResponseBody> getDeliveryToken(@NotNull String tokenUid) {
         return this.service.getDeliveryToken(this.headers, tokenUid);
@@ -77,7 +77,7 @@ public Call<ResponseBody> getDeliveryToken(@NotNull String tokenUid) {
      *
      * @param requestBody
      *         details of the delivery token in @{@link JSONObject} format
-     * @return Call<ResponseBody>
+     * @return Call
      */
     public Call<ResponseBody> createDeliveryToken(@NotNull JSONObject requestBody) {
         return this.service.createDeliveryToken(this.headers, requestBody);
@@ -96,7 +96,7 @@ public Call<ResponseBody> createDeliveryToken(@NotNull JSONObject requestBody) {
      *         the UID of the token that you want to retrieve
      * @param requestBody
      *         the body should be of @{@link JSONObject} type
-     * @return Call<ResponseBody>
+     * @return Call
      */
     public Call<ResponseBody> updateDeliveryToken(@NotNull String tokenUid, @NotNull JSONObject requestBody) {
         return this.service.updateDeliveryToken(this.headers, tokenUid, requestBody);
@@ -107,7 +107,7 @@ public Call<ResponseBody> updateDeliveryToken(@NotNull String tokenUid, @NotNull
      *
      * @param tokenUid
      *         the UID of the token that you want to retrieve
-     * @return Call<ResponseBody>
+     * @return Call
      */
     public Call<ResponseBody> deleteDeliveryToken(@NotNull String tokenUid) {
         return this.service.deleteDeliveryToken(this.headers, tokenUid, false);
@@ -120,7 +120,7 @@ public Call<ResponseBody> deleteDeliveryToken(@NotNull String tokenUid) {
      *         the UID of the token that you want to retrieve
      * @param isForce
      *         provide ‘true’ to force delete a delivery token
-     * @return Call<ResponseBody>
+     * @return Call
      */
     public Call<ResponseBody> deleteDeliveryToken(@NotNull String tokenUid, @NotNull Boolean isForce) {
         return this.service.deleteDeliveryToken(this.headers, tokenUid, isForce);
@@ -130,7 +130,7 @@ public Call<ResponseBody> deleteDeliveryToken(@NotNull String tokenUid, @NotNull
      * The Get all management tokens request returns the details of all the management tokens generated in a stack and
      * NOT the actual management tokens.
      *
-     * @return Call<ResponseBody>
+     * @return Call
      */
     public Call<ResponseBody> getManagementTokens() {
         return this.service.getManagementToken(this.headers);
@@ -142,7 +142,7 @@ public Call<ResponseBody> getManagementTokens() {
      *
      * @param tokenUid
      *         the UID of the token that you want to retrieve
-     * @return Call<ResponseBody>
+     * @return Call
      */
     public Call<ResponseBody> getManagementToken(@NotNull String tokenUid) {
         return this.service.getManagementToken(this.headers, tokenUid);
@@ -154,7 +154,7 @@ public Call<ResponseBody> getManagementToken(@NotNull String tokenUid) {
      *
      * @param requestBody
      *         details of the management token in @{@link JSONObject} format
-     * @return Call<ResponseBody>
+     * @return Call
      */
     public Call<ResponseBody> createManagementToken(@NotNull JSONObject requestBody) {
         return this.service.createManagementToken(this.headers, requestBody);
@@ -174,7 +174,7 @@ public Call<ResponseBody> createManagementToken(@NotNull JSONObject requestBody)
      *         the UID of the token that you want to retrieve
      * @param requestBody
      *         details of the management token in @{@link JSONObject} format
-     * @return Call<ResponseBody>
+     * @return Call
      */
     public Call<ResponseBody> updateManagementToken(@NotNull String tokenUid, @NotNull JSONObject requestBody) {
         return this.service.updateManagementToken(this.headers, tokenUid, requestBody);
@@ -185,7 +185,7 @@ public Call<ResponseBody> updateManagementToken(@NotNull String tokenUid, @NotNu
      *
      * @param tokenUid
      *         the UID of the token that you want to retrieve
-     * @return Call<ResponseBody>
+     * @return Call
      */
     public Call<ResponseBody> deleteManagementToken(@NotNull String tokenUid) {
         return this.service.deleteManagementToken(this.headers, tokenUid);