diff --git a/output/schema/schema.json b/output/schema/schema.json index bd280642d4..6642876d12 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -4322,7 +4322,8 @@ } }, "description": "Explore extracted and summarized information about the documents and terms in an index.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html", + "docId": "graph-explore-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/graph-explore-api.html", "name": "graph.explore", "request": { "name": "Request", @@ -106278,6 +106279,7 @@ "kind": "properties", "properties": [ { + "description": "Specifies or more fields from which you want to extract terms that are associated with the specified vertices.", "name": "connections", "required": false, "type": { @@ -106289,6 +106291,7 @@ } }, { + "description": "Direct the Graph API how to build the graph.", "name": "controls", "required": false, "type": { @@ -106300,6 +106303,7 @@ } }, { + "description": "A seed query that identifies the documents of interest. Can be any valid Elasticsearch query.", "name": "query", "required": false, "type": { @@ -106311,6 +106315,7 @@ } }, { + "description": "Specifies one or more fields that contain the terms you want to include in the graph as vertices.", "name": "vertices", "required": false, "type": { @@ -106326,7 +106331,7 @@ } ] }, - "description": "Explore extracted and summarized information about the documents and terms in an index.", + "description": "Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index.", "inherits": { "type": { "name": "RequestBase", @@ -106340,7 +106345,7 @@ }, "path": [ { - "description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices", + "description": "Name of the index.", "name": "index", "required": true, "type": { @@ -106354,7 +106359,7 @@ ], "query": [ { - "description": "Specific routing value", + "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { @@ -106366,7 +106371,7 @@ } }, { - "description": "Explicit operation timeout", + "description": "Specifies the period of time to wait for a response from each shard.\nIf no response is received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.", "name": "timeout", "required": false, "type": { @@ -106378,7 +106383,7 @@ } } ], - "specLocation": "graph/explore/GraphExploreRequest.ts#L28-L47" + "specLocation": "graph/explore/GraphExploreRequest.ts#L28-L72" }, { "body": { diff --git a/specification/graph/explore/GraphExploreRequest.ts b/specification/graph/explore/GraphExploreRequest.ts index fdb7b6e8ac..fe0953a526 100644 --- a/specification/graph/explore/GraphExploreRequest.ts +++ b/specification/graph/explore/GraphExploreRequest.ts @@ -26,22 +26,47 @@ import { Hop } from '../_types/Hop' import { VertexDefinition } from '@graph/_types/Vertex' /** + * Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + * @doc_id graph-explore-api * @rest_spec_name graph.explore * @availability stack since=0.0.0 stability=stable * @availability serverless stability=stable visibility=public */ export interface Request extends RequestBase { path_parts: { + /** + * Name of the index. + */ index: Indices } query_parameters: { + /** + * Custom value used to route operations to a specific shard. + */ routing?: Routing + /** + * Specifies the period of time to wait for a response from each shard. + * If no response is received before the timeout expires, the request fails and returns an error. + * Defaults to no timeout. + */ timeout?: Duration } body: { + /** + * Specifies or more fields from which you want to extract terms that are associated with the specified vertices. + */ connections?: Hop + /** + * Direct the Graph API how to build the graph. + */ controls?: ExploreControls + /** + * A seed query that identifies the documents of interest. Can be any valid Elasticsearch query. + */ query?: QueryContainer + /** + * Specifies one or more fields that contain the terms you want to include in the graph as vertices. + */ vertices?: VertexDefinition[] } }