# 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 Open Cypher API
  version: 1.0.0
extends: openapi/amazon-neptune-open-cypher-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: 5
- target: $.paths['/opencypher'].post
  update:
    x-apievangelist-phrasing:
      intent: Run an openCypher query against Neptune
      effect: write
      questions:
      - How do I run an openCypher query against my Neptune graph through the data API?
      - Can I pass parameters into an openCypher query instead of inlining values?
      instructions:
      - text: Run the openCypher query {query}.
        slots:
          query: requestBody.query
      - text: Execute openCypher {query} with parameters {params}.
        slots:
          query: requestBody.query
          params: requestBody.parameters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/opencypher/explain'].post
  update:
    x-apievangelist-phrasing:
      intent: Explain an openCypher query's plan
      effect: read
      questions:
      - Can I see the execution plan for an openCypher query without running it?
      - Which explain modes does Neptune offer for openCypher?
      instructions:
      - text: Explain the openCypher query {query}.
        slots:
          query: requestBody.query
      - text: Show the {mode} explain plan for openCypher {query}.
        slots:
          mode: requestBody.explainMode
          query: requestBody.query
      method: generated
      generated: '2026-10-01'
- target: $.paths['/opencypher/status'].get
  update:
    x-apievangelist-phrasing:
      intent: List running openCypher queries
      effect: read
      questions:
      - Which openCypher queries are running or queued right now?
      - What openCypher query IDs are active on my cluster?
      instructions:
      - text: Show all running and waiting openCypher queries.
      - text: List active openCypher query IDs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/opencypher/status/{queryId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of one openCypher query
      effect: read
      questions:
      - Is a specific openCypher query still running?
      - What state is the openCypher query with a given ID in?
      instructions:
      - text: Get the status of openCypher query {query_id}.
        slots:
          query_id: path.queryId
      - text: Check if openCypher query {query_id} is still executing.
        slots:
          query_id: path.queryId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/opencypher/status/{queryId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running openCypher query
      effect: destructive
      questions:
      - Can I kill an openCypher query that is taking too long?
      - What do I need to stop a stuck openCypher query?
      instructions:
      - text: Cancel openCypher query {query_id}.
        slots:
          query_id: path.queryId
      - text: Stop the runaway openCypher query {query_id}.
        slots:
          query_id: path.queryId
      method: generated
      generated: '2026-10-01'