From c9ceeb5631a74d1ead98ee87c495efc79f48b0ed Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 5 Dec 2024 10:57:40 -0800 Subject: [PATCH] [DOCS] Add graph explore operation summary (#3217) (#3245) Co-authored-by: Marci W <333176+marciw@users.noreply.github.com> (cherry picked from commit 82e466d985f00e516b7052cca6ad028dff3e573e) Co-authored-by: Lisa Cawley --- output/openapi/elasticsearch-openapi.json | 12 ++++++++++-- output/openapi/elasticsearch-serverless-openapi.json | 12 ++++++++++-- output/schema/schema.json | 8 +++++--- specification/_doc_ids/table.csv | 1 + specification/graph/explore/GraphExploreRequest.ts | 8 +++++++- 5 files changed, 33 insertions(+), 8 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 1c44f61569..d5e897172f 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -9200,7 +9200,11 @@ "tags": [ "graph" ], - "summary": "Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index", + "summary": "Explore graph analytics", + "description": "Extract and summarize information about the documents and terms in an Elasticsearch data stream or index.\nThe easiest way to understand the behaviour of this API is to use the Graph UI to explore connections.\nAn 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.\nSubsequent requests enable you to spider out from one more vertices of interest.\nYou can exclude vertices that have already been returned.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/kibana/current/xpack-graph.html" + }, "operationId": "graph-explore", "parameters": [ { @@ -9226,7 +9230,11 @@ "tags": [ "graph" ], - "summary": "Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index", + "summary": "Explore graph analytics", + "description": "Extract and summarize information about the documents and terms in an Elasticsearch data stream or index.\nThe easiest way to understand the behaviour of this API is to use the Graph UI to explore connections.\nAn 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.\nSubsequent requests enable you to spider out from one more vertices of interest.\nYou can exclude vertices that have already been returned.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/kibana/current/xpack-graph.html" + }, "operationId": "graph-explore-1", "parameters": [ { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 0502a344c1..57093f33ea 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -5708,7 +5708,11 @@ "tags": [ "graph" ], - "summary": "Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index", + "summary": "Explore graph analytics", + "description": "Extract and summarize information about the documents and terms in an Elasticsearch data stream or index.\nThe easiest way to understand the behaviour of this API is to use the Graph UI to explore connections.\nAn 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.\nSubsequent requests enable you to spider out from one more vertices of interest.\nYou can exclude vertices that have already been returned.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/kibana/current/xpack-graph.html" + }, "operationId": "graph-explore", "parameters": [ { @@ -5734,7 +5738,11 @@ "tags": [ "graph" ], - "summary": "Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index", + "summary": "Explore graph analytics", + "description": "Extract and summarize information about the documents and terms in an Elasticsearch data stream or index.\nThe easiest way to understand the behaviour of this API is to use the Graph UI to explore connections.\nAn 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.\nSubsequent requests enable you to spider out from one more vertices of interest.\nYou can exclude vertices that have already been returned.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/kibana/current/xpack-graph.html" + }, "operationId": "graph-explore-1", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index 2f51086478..ae0ac649fe 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -5446,9 +5446,11 @@ "stability": "stable" } }, - "description": "Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index.", + "description": "Explore graph analytics.\nExtract and summarize information about the documents and terms in an Elasticsearch data stream or index.\nThe easiest way to understand the behaviour of this API is to use the Graph UI to explore connections.\nAn 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.\nSubsequent requests enable you to spider out from one more vertices of interest.\nYou can exclude vertices that have already been returned.", "docId": "graph-explore-api", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/graph-explore-api.html", + "extDocId": "graph", + "extDocUrl": "https://www.elastic.co/guide/en/kibana/current/xpack-graph.html", "name": "graph.explore", "request": { "name": "Request", @@ -120443,7 +120445,7 @@ } ] }, - "description": "Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index.", + "description": "Explore graph analytics.\nExtract and summarize information about the documents and terms in an Elasticsearch data stream or index.\nThe easiest way to understand the behaviour of this API is to use the Graph UI to explore connections.\nAn 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.\nSubsequent requests enable you to spider out from one more vertices of interest.\nYou can exclude vertices that have already been returned.", "inherits": { "type": { "name": "RequestBase", @@ -120494,7 +120496,7 @@ } } ], - "specLocation": "graph/explore/GraphExploreRequest.ts#L28-L72" + "specLocation": "graph/explore/GraphExploreRequest.ts#L28-L78" }, { "kind": "response", diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 02c04d4df9..060161ef30 100644 --- 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 index c3c4393c73..797cd5b371 100644 --- 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: {