Skip to content

Commit 16921eb

Browse files
patelvpjrodewig
andcommitted
[DOCS] Collapse nested objects in Explore API docs (#55067)
Co-authored-by: James Rodewig <james.rodewig@elastic.co>
1 parent c5c7ee9 commit 16921eb

1 file changed

Lines changed: 21 additions & 5 deletions

File tree

docs/reference/graph/explore.asciidoc

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ vertices that have already been returned.
3232
[float]
3333
=== Request Body
3434

35+
[role="child_attributes"]
36+
====
37+
3538
query::
3639
A seed query that identifies the documents of interest. Can be any valid
3740
Elasticsearch query. For example:
@@ -71,7 +74,10 @@ graph as vertices. For example:
7174
}
7275
]
7376
--------------------------------------------------
74-
77+
+
78+
.Properties for `vertices`
79+
[%collapsible%open]
80+
======
7581
field::: Identifies a field in the documents of interest.
7682
include::: Identifies the terms of interest that form the starting points
7783
from which you want to spider out. You do not have to specify a seed query
@@ -93,6 +99,7 @@ shard_min_doc_count:::
9399
This advanced setting controls how many documents on a particular shard have
94100
to contain a pair of terms before the connection is returned for global
95101
consideration. Defaults to 2.
102+
======
96103
97104
connections::
98105
Specifies or more fields from which you want to extract terms that are
@@ -113,7 +120,10 @@ NOTE: Connections can be nested inside the `connections` object to
113120
explore additional relationships in the data. Each level of nesting is
114121
considered a _hop_, and proximity within the graph is often described in
115122
terms of _hop depth_.
116-
123+
+
124+
.Properties for `connections`
125+
[%collapsible%open]
126+
======
117127
query:::
118128
An optional _guiding query_ that constrains the Graph API as it
119129
explores connected terms. For example, you might want to direct the Graph
@@ -133,9 +143,13 @@ Contains the fields you are interested in. For example:
133143
}
134144
]
135145
--------------------------------------------------
146+
======
136147
137148
controls:: Direct the Graph API how to build the graph.
138-
149+
+
150+
.Properties for `controls`
151+
[%collapsible%open]
152+
======
139153
use_significance:::
140154
The `use_significance` flag filters associated terms so only those that are
141155
significantly associated with your query are included. For information about
@@ -168,6 +182,8 @@ a maximum number of documents per value for that field. For example:
168182
"max_docs_per_value": 500
169183
}
170184
--------------------------------------------------
185+
======
186+
====
171187

172188
// [float]
173189
// === Authorization
@@ -279,7 +295,7 @@ not a global count for all documents in the index).
279295

280296
The default settings are configured to remove noisy data and
281297
get the "big picture" from your data. This example shows how to specify
282-
additional parameters to influence how the graph is built.
298+
additional parameters to influence how the graph is built.
283299

284300
For tips on tuning the settings for more detailed forensic evaluation where
285301
every document could be of interest, see the
@@ -401,4 +417,4 @@ POST clicklogs/_graph/explore
401417
<1> The vertices you want to start from are specified
402418
as an array of terms in an `include` clause.
403419
<2> The `exclude` clause prevents terms you already know about from being
404-
included in the results.
420+
included in the results.

0 commit comments

Comments
 (0)