Skip to content

Commit 342de85

Browse files
lcawlmarciw
authored andcommitted
[DOCS] Add graph explore operation summary (#3217)
Co-authored-by: Marci W <[email protected]> (cherry picked from commit 82e466d)
1 parent 278b672 commit 342de85

File tree

5 files changed

+33
-8
lines changed

5 files changed

+33
-8
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 10 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/openapi/elasticsearch-serverless-openapi.json

Lines changed: 10 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 5 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/_doc_ids/table.csv

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,7 @@ get-trained-models,https://www.elastic.co/guide/en/elasticsearch/reference/{bran
187187
get-transform-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-transform-stats.html
188188
get-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-transform.html
189189
get-trial-status,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-trial-status.html
190+
graph,https://www.elastic.co/guide/en/kibana/{branch}/xpack-graph.html
190191
graph-explore-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/graph-explore-api.html
191192
grok-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/grok-processor.html
192193
gsub-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/gsub-processor.html

specification/graph/explore/GraphExploreRequest.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,17 @@ import { ExploreControls } from '../_types/ExploreControls'
2626
import { Hop } from '../_types/Hop'
2727

2828
/**
29-
* Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index.
29+
* Explore graph analytics.
30+
* Extract and summarize information about the documents and terms in an Elasticsearch data stream or index.
31+
* The easiest way to understand the behavior of this API is to use the Graph UI to explore connections.
32+
* An initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph.
33+
* Subsequent requests enable you to spider out from one more vertices of interest.
34+
* You can exclude vertices that have already been returned.
3035
* @doc_id graph-explore-api
3136
* @rest_spec_name graph.explore
3237
* @availability stack stability=stable
3338
* @availability serverless stability=stable visibility=public
39+
* @ext_doc_id graph
3440
*/
3541
export interface Request extends RequestBase {
3642
path_parts: {

0 commit comments

Comments
 (0)