Skip to content

[DOCS] Add graph explore operation summary #3217

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Dec 4, 2024
Merged

[DOCS] Add graph explore operation summary #3217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e68ca25
[DOCS] Add graph explore operation summary
lcawl Dec 3, 2024
01263cb
Generate output
lcawl Dec 3, 2024
03bd5eb
Update specification/_doc_ids/table.csv
lcawl Dec 3, 2024
828ad53
Update specification/graph/explore/GraphExploreRequest.ts
lcawl Dec 4, 2024
d6d37e4
Merge branch 'main' into graph-api-summary
lcawl Dec 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions output/openapi/elasticsearch-openapi.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 10 additions & 2 deletions output/openapi/elasticsearch-serverless-openapi.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 5 additions & 3 deletions output/schema/schema.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions specification/_doc_ids/table.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,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
Expand Down
8 changes: 7 additions & 1 deletion specification/graph/explore/GraphExploreRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
Loading