# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Amazon Neptune Data Gremlin API
  version: 1.0.0
extends: openapi/amazon-neptune-gremlin-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/gremlin'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a Gremlin query against Neptune
      effect: write
      questions:
      - How do I run a Gremlin traversal against my Neptune graph through the data API?
      - Can I add or change vertices with a Gremlin query and get the results back right away?
      instructions:
      - text: Run the Gremlin query {gremlin} on my Neptune graph.
        slots:
          gremlin: requestBody.gremlin
      - text: 'Execute this traversal and return the results: {gremlin}.'
        slots:
          gremlin: requestBody.gremlin
      method: generated
      generated: '2026-10-01'
- target: $.paths['/gremlin/explain'].post
  update:
    x-apievangelist-phrasing:
      intent: Explain a Gremlin query's execution plan
      effect: read
      questions:
      - Can I see how Neptune would execute a Gremlin traversal without actually running it?
      - Why is my Gremlin query slow, and what plan does the engine pick?
      instructions:
      - text: Explain the execution plan for the Gremlin query {gremlin}.
        slots:
          gremlin: requestBody.gremlin
      - text: Show me the Gremlin explain output for {gremlin} without touching data.
        slots:
          gremlin: requestBody.gremlin
      method: generated
      generated: '2026-10-01'
- target: $.paths['/gremlin/profile'].post
  update:
    x-apievangelist-phrasing:
      intent: Profile a Gremlin query with runtime stats
      effect: read
      questions:
      - How long does each step of my Gremlin traversal actually take?
      - Can I profile a Gremlin query and include index operation details?
      instructions:
      - text: Profile the Gremlin query {gremlin} and report its runtime statistics.
        slots:
          gremlin: requestBody.gremlin
      - text: Profile {gremlin} including index operations set to {index_ops}.
        slots:
          gremlin: requestBody.gremlin
          index_ops: requestBody.indexOps
      method: generated
      generated: '2026-10-01'
- target: $.paths['/gremlin/status'].get
  update:
    x-apievangelist-phrasing:
      intent: List running and queued Gremlin queries
      effect: read
      questions:
      - Which Gremlin queries are running or waiting on my Neptune cluster right now?
      - What Gremlin query IDs are currently active?
      instructions:
      - text: Show all running and waiting Gremlin queries.
      - text: List the active Gremlin query IDs and their statuses.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/gremlin/status/{queryId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of one Gremlin query
      effect: read
      questions:
      - Is a particular Gremlin query still running?
      - What state is the Gremlin query with a given ID in?
      instructions:
      - text: Get the status of Gremlin query {query_id}.
        slots:
          query_id: path.queryId
      - text: Check if Gremlin query {query_id} is still executing.
        slots:
          query_id: path.queryId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/gremlin/status/{queryId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running Gremlin query
      effect: destructive
      questions:
      - Can I kill a long-running Gremlin traversal?
      - What do I need to stop a stuck Gremlin query?
      instructions:
      - text: Cancel Gremlin query {query_id}.
        slots:
          query_id: path.queryId
      - text: Stop the runaway Gremlin traversal {query_id}.
        slots:
          query_id: path.queryId
      method: generated
      generated: '2026-10-01'