CS-42937 : Support for Early Access Header

CS-42936 : Taxonomy document and Test
contentstack · Dec 15, 2023 · c443286 · c443286
1 parent f9c518b
commit c443286
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 7 deletions.
diff --git a/src/main/java/com/contentstack/cms/stack/Entry.java b/src/main/java/com/contentstack/cms/stack/Entry.java
@@ -104,6 +104,7 @@ public Entry addHeaders(@NotNull HashMap<String, String> headers) {
      * Set header for the request
      *
      * @param key Removes query param using key of request
+     * @return instance of {@link Entry}
      */
     public Entry removeParam(@NotNull String key) {
         this.params.remove(key);

diff --git a/src/main/java/com/contentstack/cms/stack/Stack.java b/src/main/java/com/contentstack/cms/stack/Stack.java
@@ -845,7 +845,7 @@ public Taxonomy taxonomy() {
      *
      * @param taxonomyUid the taxonomy uid
      * @return instance of Taxonomy
-     * <p></p>
+     * <br>
      * <pre>
      * {@code
      * Stack stack = new Contentstack.Builder().setAuthtoken("authtoken").build().stack();

diff --git a/src/main/java/com/contentstack/cms/stack/Terms.java b/src/main/java/com/contentstack/cms/stack/Terms.java
@@ -116,7 +116,7 @@ public Terms addHeaders(@NotNull HashMap<String, String> headers) {
      * Create Terms call.
      *
      * @param body The JSONObject request body
-     * @return instance of Call <p></p> <b>Example</b> <pre>     {@code
+     * @return instance of Call <br> <b>Example</b> <pre>     {@code
      *     Stack stack = new Contentstack.Builder().build().stack(headers);
      *     JSONObject body = new JSONObject();
      *     Term term = stack.taxonomy("taxonomyId").terms().create(body);
@@ -161,7 +161,7 @@ public Call<ResponseBody> create(@NotNull JSONObject body) {
      * <b>limit</b> - Limit the result to number of documents/nodes
      * </li>
      * </ul>
-     * <p></p>
+     * <br>
      * <b>Example</b>
      * <pre>
      *     {@code
@@ -181,7 +181,7 @@ public Call<ResponseBody> find() {
      * Fetch single term based on term uid.
      *
      * @param termUid The term for which we need the details
-     * @return instance of call <p> Supported Query Parameters: to use query parameters use #addParams("key", "value"); <ul>  <li><b>include_children_count</b> - Include count of number of children under each term <li>     <b>include_referenced_entries_count</b> - Include count of the entries where this term is referred </li> </ul> <p></p> <b>Example</b> <pre>     {@code
+     * @return instance of call <br> Supported Query Parameters: to use query parameters use #addParams("key", "value"); <ul>  <li><b>include_children_count</b> - Include count of number of children under each term <li>     <b>include_referenced_entries_count</b> - Include count of the entries where this term is referred </li> </ul> <br> <b>Example</b> <pre>     {@code
      *     Stack stack = new Contentstack.Builder().build().stack(headers);
      *     Term term = stack.taxonomy("taxonomyId").terms().find();
      *     } </pre>
@@ -198,7 +198,7 @@ public Call<ResponseBody> fetch(@NotNull String termUid) {
      * @return The details of the term descendants <p> URL/Query parameters <ul>     <li>     <b>depth</b> - Include the terms upto the depth specified if set to a number greater than 0, include all the terms if set to 0, default depth will be set to 1     </li><li>     <b>include_children_count</b> - Include count of number of children under each term     </li><li>     <b>include_referenced_entries_count</b> - Include count of the entries where atleast 1 term of this taxonomy is referred     </li><li>     <b>include_count</b> - Include count of the documents/nodes that matched the query     </li><li>     <b>skip</b> - Skip the number of documents/nodes     </li><li>     <b>limit</b> - Limit the result to number of documents/nodes     </li> </ul> <p> <b>Example</b> <pre> {@code
      *      Stack stack = new Contentstack.Builder().build().stack(headers);
      *      Term term = stack.taxonomy("taxonomyId").terms().descendants("termId").;
-     *     }     </pre> <p>
+     *     }     </pre> <br>
      */
     public Call<ResponseBody> descendants(@NotNull String termUid) {
         return this.taxonomyService.descendantsTerm(this.headers, this.taxonomyId, termUid, this.params);
@@ -250,15 +250,15 @@ public Call<ResponseBody> update(@NotNull String termUid, @NotNull JSONObject bo
      *                "order": 2
      *                }
      *                }
-     *                <p>
+     *                <br>
      *                //Under an existing Term on a different level:
      *                {
      *                "term": {
      *                "parent_uid": "term_1",
      *                "order": 5
      *                }
      *                }
-     *                <p>
+     *                <br>
      *                //Under an existing Term on the same level(Reorder Term):
      *                {
      *                "term": {