Skip to content

Commit eacce9c

Browse files
CS-42937 : Support for Early Access Header
CS-42936 : Taxonomy document and Test
1 parent 253f3fb commit eacce9c

File tree

3 files changed

+8
-7
lines changed

3 files changed

+8
-7
lines changed

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

+1
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,7 @@ public Entry addHeaders(@NotNull HashMap<String, String> headers) {
104104
* Set header for the request
105105
*
106106
* @param key Removes query param using key of request
107+
* @return instance of {@link Entry}
107108
*/
108109
public Entry removeParam(@NotNull String key) {
109110
this.params.remove(key);

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -845,7 +845,7 @@ public Taxonomy taxonomy() {
845845
*
846846
* @param taxonomyUid the taxonomy uid
847847
* @return instance of Taxonomy
848-
* <p></p>
848+
* <br>
849849
* <pre>
850850
* {@code
851851
* Stack stack = new Contentstack.Builder().setAuthtoken("authtoken").build().stack();

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

+6-6
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ public Terms addHeaders(@NotNull HashMap<String, String> headers) {
116116
* Create Terms call.
117117
*
118118
* @param body The JSONObject request body
119-
* @return instance of Call <p></p> <b>Example</b> <pre> {@code
119+
* @return instance of Call <br> <b>Example</b> <pre> {@code
120120
* Stack stack = new Contentstack.Builder().build().stack(headers);
121121
* JSONObject body = new JSONObject();
122122
* Term term = stack.taxonomy("taxonomyId").terms().create(body);
@@ -161,7 +161,7 @@ public Call<ResponseBody> create(@NotNull JSONObject body) {
161161
* <b>limit</b> - Limit the result to number of documents/nodes
162162
* </li>
163163
* </ul>
164-
* <p></p>
164+
* <br>
165165
* <b>Example</b>
166166
* <pre>
167167
* {@code
@@ -181,7 +181,7 @@ public Call<ResponseBody> find() {
181181
* Fetch single term based on term uid.
182182
*
183183
* @param termUid The term for which we need the details
184-
* @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
184+
* @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
185185
* Stack stack = new Contentstack.Builder().build().stack(headers);
186186
* Term term = stack.taxonomy("taxonomyId").terms().find();
187187
* } </pre>
@@ -198,7 +198,7 @@ public Call<ResponseBody> fetch(@NotNull String termUid) {
198198
* @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
199199
* Stack stack = new Contentstack.Builder().build().stack(headers);
200200
* Term term = stack.taxonomy("taxonomyId").terms().descendants("termId").;
201-
* } </pre> <p>
201+
* } </pre> <br>
202202
*/
203203
public Call<ResponseBody> descendants(@NotNull String termUid) {
204204
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
250250
* "order": 2
251251
* }
252252
* }
253-
* <p>
253+
* <br>
254254
* //Under an existing Term on a different level:
255255
* {
256256
* "term": {
257257
* "parent_uid": "term_1",
258258
* "order": 5
259259
* }
260260
* }
261-
* <p>
261+
* <br>
262262
* //Under an existing Term on the same level(Reorder Term):
263263
* {
264264
* "term": {

0 commit comments

Comments
 (0)