package info.java

package info.java to add package info

Author: ishaileshmishra

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

@@ -1,3 +1,7 @@
+
+/**
+ * The top most package to access contentstack instance
+ */
 package com.contentstack.cms;
 
 import com.contentstack.cms.core.AuthInterceptor;
@@ -29,7 +33,7 @@
  * <br>
  * <b>Contentstack Java Management SDK</b> interact with the Content Management APIs and allow you to create, update,
  * delete, and fetch content from your Contentstack account. They are read-write in nature.
- * <b>
+ * <br>
  * You can use them to build your own apps and manage your content from Contentstack.
  */
 public class Contentstack {
@@ -420,7 +424,6 @@ public Builder() {
          * <br>
          * <pre>
          * {
-         * @code
          * Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress("hostname", 433));
          * Contentstack contentstack = new Contentstack.Builder().setProxy(proxy).build();
          * }

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

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

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

@@ -0,0 +1,4 @@
+/**
+ * Useful to access contentstack's models and pojo classes
+ */
+package com.contentstack.cms.models;

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

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

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

@@ -0,0 +1,5 @@
+/**
+ * This is topmost package that is used to contains all the sub-packages in itself
+ * like core, models, organisations, stacks, users and contentstack
+ */
+package com.contentstack.cms;

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

@@ -116,6 +116,8 @@ public Call<ResponseBody> single(@NotNull String uid) {
      * You can use the same request to update the target branch of an alias. In the “Body” section, you need to provide
      * the UID of the new target branch that will be associated with the alias.
      *
+     * @param body
+     *         the request body
      * @return Call
      * @see <a
      * href="https://www.contentstack.com/docs/developers/apis/content-management-api/#assign-or-update-an-alias">Update
@@ -134,6 +136,8 @@ public Call<ResponseBody> update(@NotNull JSONObject body) {
      * <p>
      * When executing the API call, in the “URL Parameters” section, provide the UID of your alias.
      *
+     * @param branchUid
+     *         the branch uid
      * @return Call
      * @see <a href="https://www.contentstack.com/docs/developers/apis/content-management-api/#delete-an-alias">Delete a
      * branch</a>

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

@@ -205,27 +205,19 @@ public Call<ResponseBody> subfolder(
      * @param requestBody
      *         Request body for the asset file
      *         <ul>
-     *         <br>
      *         <li>asset[upload] (mandatory) Select the input type as 'File'. Then, browse and select the asset file that
      *         you want to import. Supported file types include JPG, GIF, PNG, XML, WebP, BMP, TIFF, SVG, and PSD</li>
-     *         <br>
      *         <li>asset[parent_uid] (optional) If needed, assign a parent folder to your asset by passing the UID of the
      *         parent folder.</li>
-     *         <br>
+     *
      *         <li>asset[title] (optional) Enter a title for your uploaded asset.</li>
-     *         <br>
      *         <li>asset[description] (optional) Enter a description for your uploaded asset.</li>
-     *         <br>
      *         <li>asset[tags] (optional) Assign a specific tag(s) to your uploaded asset. {@link #addParam(String, Object)}
      *         The query parameter for the asset to upload</li>
-     *         <br>
      *         <li>relative_urls(optional) Set this to 'true' to display the relative URL of the asset. Example:false</li>
-     *         <br>
      *         <li>include_dimension(optional) Set this to 'true' to include the dimensions (height and width) of the image
      *         in the response.</li>
-     *         <br>
      *         </ul>
-     *         <br>
      * @return Call
      * @see <a href="https://www.contentstack.com/docs/developers/apis/content-management-api/#upload-asset"> Upload
      * Asset</a>
@@ -319,7 +311,7 @@ public Call<ResponseBody> generatePermanentUrl(String uid, JSONObject body) {
      * @return Call
      * @see <a
      * href="https://www.contentstack.com/docs/developers/apis/content-management-api/#generate-permanent-asset-url">
-     * Generate Permanent Asset Url
+     * Generate Permanent Asset Url</a>
      * @see #addHeader(String, Object) to add headers
      * @see #addParam(String, Object) to add query params
      * @since 1.0.0
@@ -333,6 +325,7 @@ public Call<ResponseBody> getPermanentUrl(String uid, String slugUrl) {
      *
      * @param uid
      *         the UID of the asset you want to delete asset
+     * @return Call
      * @see <a href="https://www.contentstack.com/docs/developers/apis/content-management-api/#delete-asset"> Delete
      * Asset
      * </a>
@@ -350,7 +343,7 @@ public Call<ResponseBody> delete(@NotNull String uid) {
      * @return Call
      * @see <a
      * href="https://www.contentstack.com/docs/developers/apis/content-management-api/#get-information-on-rte-assets">
-     * Get Information On RTE Assets
+     * Get Information On RTE Assets</a>
      * @see #addHeader(String, Object) to add headers
      * @see #addParam(String, Object) to add query params
      * @since 1.0.0
@@ -381,7 +374,7 @@ public Call<ResponseBody> rteInformation() {
      * @return Call
      * @see <a
      * href="https://www.contentstack.com/docs/developers/apis/content-management-api/#get-information-on-rte-assets">
-     * Get Information On RTE Assets
+     * Get Information On RTE Assets</a>
      * @see #addHeader(String, Object) to add headers
      * @since 1.0.0
      */
@@ -416,7 +409,7 @@ public Call<ResponseBody> setVersionName(@NotNull String assetUid, int versionNu
      * @return Call
      * @see <a
      * href="https://www.contentstack.com/docs/developers/apis/content-management-api/#get-details-of-all-versions-of-an-asset">
-     * Get Details of All Versions of an Asset
+     * Get Details of All Versions of an Asset</a>
      * @see #addParam(String, Object)  to add Query parameters
      * @see #addHeader(String, Object) to add headers
      * @since 1.0.0
@@ -438,7 +431,7 @@ public Call<ResponseBody> getVersionNameDetails(@NotNull String assetUid) {
      * @return Call
      * @see <a
      * href="https://www.contentstack.com/docs/developers/apis/content-management-api/#delete-version-name-of-asset">
-     * Delete Version Name Of Asset
+     * Delete Version Name Of Asset</a>
      * @see #addHeader(String, Object) to add headers
      * @since 1.0.0
      */
@@ -454,7 +447,7 @@ public Call<ResponseBody> deleteVersionName(@NotNull String assetUid, int versio
      *         asset uid
      * @return Call
      * @see <a href="https://www.contentstack.com/docs/developers/apis/content-management-api/#get-asset-references">
-     * Get Asset References
+     * Get Asset References</a>
      * @see #addHeader(String, Object) to add headers
      * @since 1.0.0
      */
@@ -494,23 +487,23 @@ public Call<ResponseBody> getByType(@NotNull String assetType) {
      * and also provide a "Title" and a "Description" for the asset. Another way to provide a "Title" and a
      * "Description" for the asset is to pass them as optional form-data parameters, i.e., asset[title] and
      * asset[description].
-     * <p>
-     * Here's an example of the raw body:
-     * <p>
+     * <br>
+     * <b>Here's an example of the body:</b>
+     * <br>
      * <pre>
-     *  @code { "asset": { "title": "Title", "description": "Description" }, "version": 3 }
+     *  { "asset": { "title": "Title", "description": "Description" }, "version": 3 }
      * </pre>
      *
      * @param assetUid
      *         The UID of the asset that you want to update details.
      * @param requestBody
-     *         JSON Request body
+     *         The request body
      * @return Call
      * @see #addHeader(String, Object) to add headers
      * @see #addParam(String, Object) to add query params
      * @since 1.0.0
      */
-    public Call<ResponseBody> updateDetails(@NotNull String assetUid, @NotNull JSONObject requestBody) {
+    public Call<ResponseBody> updateDetails(@NotNull String assetUid, JSONObject requestBody) {
         return this.service.updateDetails(this.headers, assetUid, this.params, requestBody);
     }
 
@@ -530,7 +523,7 @@ public Call<ResponseBody> updateDetails(@NotNull String assetUid, @NotNull JSONO
      *         JSON Request body
      * @return Call
      * @see <a href="https://www.contentstack.com/docs/developers/apis/content-management-api/#publish-an-asset">
-     * Publish An Asset
+     * Publish An Asset</a>
      * @see #addHeader(String, Object) to add headers
      * @since 1.0.0
      */
@@ -553,7 +546,7 @@ public Call<ResponseBody> publish(@NotNull String assetUid, @NotNull JSONObject
      *         JSON Request body
      * @return Call
      * @see <a href="https://www.contentstack.com/docs/developers/apis/content-management-api/#unpublish-an-asset">
-     * Unpublish An Asset
+     * Unpublish An Asset</a>
      * @see #addHeader(String, Object) to add headers
      * @since 1.0.0
      */
@@ -575,7 +568,7 @@ public Call<ResponseBody> unpublish(
      *         Example:false
      * @return Call
      * @see <a href="https://www.contentstack.com/docs/developers/apis/content-management-api/#unpublish-an-asset">
-     * Unpublish An Asset
+     * Unpublish An Asset</a>
      * @see #addHeader(String, Object) to add headers
      * @see #addParam(String, Object) to add query params
      * @since 1.0.0
@@ -597,7 +590,7 @@ public Call<ResponseBody> singleFolder(
      * @return Call
      * @see <a
      * href="https://www.contentstack.com/docs/developers/apis/content-management-api/#get-a-single-folder-by-name"> Get
-     * A Single Folder By Name
+     * A Single Folder By Name</a>
      * @see #addHeader(String, Object) to add headers
      * @see #addParam(String, Object) to add query params
      * @since 1.0.0
@@ -615,7 +608,7 @@ public Call<ResponseBody> getSingleFolderByName() {
      * @return Call
      * @see <a
      * href="https://www.contentstack.com/docs/developers/apis/content-management-api/#get-subfolders-of-a-parent-folder">
-     * Get subfolders of a parent folder
+     * Get subfolders of a parent folder</a>
      * @see #addHeader(String, Object) to add headers
      * @see #addParam(String, Object) to add query params
      * @since 1.0.0
@@ -644,7 +637,7 @@ public Call<ResponseBody> getSubfolder() {
      *         JSONObject request body
      * @return Call
      * @see <a href="https://www.contentstack.com/docs/developers/apis/content-management-api/#create-a-folder"> Create
-     * a folder
+     * a folder</a>
      * @see #addHeader(String, Object) to add headers
      * @see #addParam(String, Object) to add query params
      * @since 1.0.0
@@ -674,7 +667,7 @@ public Call<ResponseBody> createFolder(@Nullable JSONObject requestBody) {
      *         JSONObject request body { "asset": { "name": "Demo" } }
      * @return Call
      * @see <a href="https://www.contentstack.com/docs/developers/apis/content-management-api/#update-or-move-folder">
-     * Update ORr Move Folder
+     * Update ORr Move Folder</a>
      * @see #addHeader(String, Object) to add headers
      * @see #addParam(String, Object) to add query params
      * @since 1.0.0
@@ -692,7 +685,7 @@ public Call<ResponseBody> updateFolder(@NotNull String folderUid, @Nullable JSON
      *         The UID of the asset folder that you want to delete
      * @return Call
      * @see <a href="https://www.contentstack.com/docs/developers/apis/content-management-api/#delete-a-folder">
-     * Delete A Folder
+     * Delete A Folder</a>
      * @see #addHeader(String, Object) to add headers
      * @see #addParam(String, Object) to add query params
      * @since 1.0.0

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

@@ -111,7 +111,7 @@ public Call<ResponseBody> single(@NotNull String uid) {
 
     /**
      * The Create a branch request creates a new branch in a particular stack of your organization.
-     *
+     * @param body the request body
      * @return Call
      * @see <a href="https://www.contentstack.com/docs/developers/apis/content-management-api/#create-a-branch">Create a
      * branch</a>
@@ -126,6 +126,8 @@ public Call<ResponseBody> create(@NotNull JSONObject body) {
      * The Get assets and folders of a parent folder retrieves details of both assets and asset subfolders within a
      * specific parent asset folder.
      *
+     * @param branchUid
+     *         The unique ID of the branch of which you want to retrieve the details.
      * @return Call
      * @see <a href="https://www.contentstack.com/docs/developers/apis/content-management-api/#delete-a-branch">Delete a
      * branch</a>

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

@@ -148,11 +148,10 @@ public Call<ResponseBody> single(@NotNull String entryUid) {
      * <br>
      *
      * @param requestBody
-     *         Provide the Json Body to create entry: <pre
-     *         <code>
-     *         { "entry": { "title": "Entry title", "url": "Entry URL", "reference_field_uid": [{ "uid": "the_uid",
-     *         "_content_type_uid": "referred_content_type_uid" }] } }</code>
-     *         </pre>
+     *         Provide the Json Body to create entry: <pre>
+     *                 { "entry": { "title": "Entry title", "url": "Entry URL", "reference_field_uid": [{ "uid": "the_uid",
+     *                 "_content_type_uid": "referred_content_type_uid" }] } }
+     *                 </pre>
      * @return Call
      * @see <a href="https://www.contentstack.com/docs/developers/apis/content-management-api/#create-an-entry">Create A
      * Entry</a>
@@ -171,7 +170,7 @@ public Call<ResponseBody> create(JSONObject requestBody) {
      * <br>
      * <b>Note:</b> The Update an entry call does not allow you to update the
      * workflow stage for an entry. To update the workflow stage for the entry, use the Set Entry Workflow Stage call.
-     * </p>
+     * <br>
      *
      * @param entryUId
      *         the unique ID of the content type of which you wish to retrieve the details. The uid is generated based

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

@@ -137,12 +137,7 @@ public Call<ResponseBody> single(@NotNull String environment) {
      *
      * @param body
      *         The {@link JSONObject} request body<br>
-     *         <b>Example:</b>
-     *         <pre
      * @return Call
-     * @code{ { "environment": { "name": "development", "servers": [ { "name": "default" } ], "urls": [ { "locale":
-     * "en-us", "url": "http://example.com/" } ], "deploy_content": true } }}
-     * </pre>
      * @see <a
      * href="https://www.contentstack.com/docs/developers/apis/content-management-api/#environment-collection">Get all
      * environments
@@ -173,7 +168,7 @@ public Call<ResponseBody> create(@NotNull JSONObject body) {
      * @return Call
      * @see <a
      * href="https://www.contentstack.com/docs/developers/apis/content-management-api/#update-environment">Update
-     * Environment
+     * Environment</a>
      * @see #addHeader(String, Object) to add headers to the request
      * @since 1.0.0
      */
@@ -193,7 +188,7 @@ public Call<ResponseBody> update(@NotNull String environmentName, @NotNull JSONO
      * @return Call
      * @see <a
      * href="https://www.contentstack.com/docs/developers/apis/content-management-api/#delete-environment">Delete
-     * Environment
+     * Environment</a>
      * @see #addHeader(String, Object) to add headers to the request
      * @since 1.0.0
      */