Skip to content

Commit f583a3f

Browse files
authored
Adds collapsible sections to API template (#1789)
1 parent 6ad8146 commit f583a3f

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

shared/api-ref-ex.asciidoc

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,9 @@ and `manage_follow_index` index privileges...
5757
////
5858
Add a more detailed description the context.
5959
Link to related APIs if appropriate.
60+
////
6061

62+
////
6163
Guidelines for parameter documentation
6264
***************************************
6365
* Use a definition list.
@@ -67,11 +69,8 @@ Guidelines for parameter documentation
6769
* Include a range of valid values, if applicable.
6870
* If the parameter requires a specific delimiter for multiple values, say so.
6971
* If the parameter supports wildcards, ditto.
70-
* For large or nested objects, consider linking to a separate definition list.
7172
***************************************
7273
////
73-
74-
7574
[[sample-api-path-params]]
7675
==== {api-path-parms-title}
7776
////
@@ -97,7 +96,14 @@ files to the follower index. The default is `0`, which means waiting on none of
9796
the shards to be active.
9897
////
9998

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+
////
101107
[[sample-api-request-body]]
102108
==== {api-request-body-title}
103109
////
@@ -110,6 +116,7 @@ the leader index.
110116
111117
`leader_index`::
112118
(Required, string) The name of the index in the leader cluster to follow.
119+
113120
////
114121

115122

0 commit comments

Comments
 (0)