[DOCS] Add graph explore operation summary (#3217) (#3245)

Co-authored-by: Marci W <[email protected]> (cherry picked from commit 82e466d) Co-authored-by: Lisa Cawley <[email protected]>
elastic · Dec 5, 2024 · c9ceeb5 · c9ceeb5
1 parent eca88ad
commit c9ceeb5
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 8 deletions.
diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json
diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json
diff --git a/output/schema/schema.json b/output/schema/schema.json
diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv
@@ -187,6 +187,7 @@ get-trained-models,https://www.elastic.co/guide/en/elasticsearch/reference/{bran
 get-transform-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-transform-stats.html
 get-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-transform.html
 get-trial-status,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-trial-status.html
+graph,https://www.elastic.co/guide/en/kibana/{branch}/xpack-graph.html
 graph-explore-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/graph-explore-api.html
 grok-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/grok-processor.html
 gsub-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/gsub-processor.html

diff --git a/specification/graph/explore/GraphExploreRequest.ts b/specification/graph/explore/GraphExploreRequest.ts
@@ -26,11 +26,17 @@ import { ExploreControls } from '../_types/ExploreControls'
 import { Hop } from '../_types/Hop'
 
 /**
- * Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index.
+ * Explore graph analytics.
+ * Extract and summarize information about the documents and terms in an Elasticsearch data stream or index.
+ * The easiest way to understand the behavior of this API is to use the Graph UI to explore connections.
+ * 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.
+ * Subsequent requests enable you to spider out from one more vertices of interest.
+ * You can exclude vertices that have already been returned.
  * @doc_id graph-explore-api
  * @rest_spec_name graph.explore
  * @availability stack stability=stable
  * @availability serverless stability=stable visibility=public
+ * @ext_doc_id graph
  */
 export interface Request extends RequestBase {
   path_parts: {