Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Elasticsearch Request & Response Specification Graph API

3 actions 3 updates phrasing extends openapi/elk-stack-graph-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Elastic Stack's API. It is a proposal applied on top of the contract, not a document Elastic Stack publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/{index}/_graph/explore'].get

$.paths['/{index}/_graph/explore'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Elasticsearch Request & Response Specification Graph API
  version: 1.0.0
extends: openapi/elk-stack-graph-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/{index}/_graph/explore'].get
  update:
    x-apievangelist-phrasing:
      intent: Explore term connections via GET
      effect: read
      questions:
      - Can I find related terms in an index with a GET graph explore request?
      - Does GET graph explore accept vertices and connections in the body?
      instructions:
      - text: Run a GET graph explore on {index} with vertices {vertices}.
        slots:
          index: path.index
          vertices: requestBody.vertices
      - text: GET graph connections in {index} starting from query {query}.
        slots:
          index: path.index
          query: requestBody.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{index}/_graph/explore'].post
  update:
    x-apievangelist-phrasing:
      intent: Explore term connections via POST
      effect: read
      questions:
      - How do I POST a graph exploration to discover how terms in my data relate?
      - Can a POST graph explore request control sample size and significance?
      instructions:
      - text: POST a graph explore to {index} with vertices {vertices} and connections {connections}.
        slots:
          index: path.index
          vertices: requestBody.vertices
          connections: requestBody.connections
      - text: Send a POST graph exploration on {index} using controls {controls}.
        slots:
          index: path.index
          controls: requestBody.controls
      method: generated
      generated: '2026-09-26'