@@ -57,7 +57,9 @@ and `manage_follow_index` index privileges...
57
57
////
58
58
Add a more detailed description the context.
59
59
Link to related APIs if appropriate.
60
+ ////
60
61
62
+ ////
61
63
Guidelines for parameter documentation
62
64
***************************************
63
65
* Use a definition list.
@@ -67,11 +69,8 @@ Guidelines for parameter documentation
67
69
* Include a range of valid values, if applicable.
68
70
* If the parameter requires a specific delimiter for multiple values, say so.
69
71
* If the parameter supports wildcards, ditto.
70
- * For large or nested objects, consider linking to a separate definition list.
71
72
***************************************
72
73
////
73
-
74
-
75
74
[[sample-api-path-params]]
76
75
==== {api-path-parms-title}
77
76
////
@@ -97,7 +96,14 @@ files to the follower index. The default is `0`, which means waiting on none of
97
96
the shards to be active.
98
97
////
99
98
100
-
99
+ ////
100
+ Guidelines for request and response body documentation
101
+ ***************************************
102
+ * For large or nested objects, consider linking to a separate definition list
103
+ or using a collapsible section. For example, see the "get node stats" API or the
104
+ "create anomaly detection jobs" API.
105
+ ***************************************
106
+ ////
101
107
[[sample-api-request-body]]
102
108
==== {api-request-body-title}
103
109
////
@@ -110,6 +116,7 @@ the leader index.
110
116
111
117
`leader_index`::
112
118
(Required, string) The name of the index in the leader cluster to follow.
119
+
113
120
////
114
121
115
122
0 commit comments