# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Query Service Queries API
  version: 1.0.0
extends: openapi/adobe-suite-queries-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: 4
- target: $.paths['/queries'].get
  update:
    x-apievangelist-phrasing:
      intent: List Query Service queries
      effect: read
      questions:
      - How do I list the SQL queries run in my Experience Platform org?
      - Can I include soft-deleted queries in the list?
      - Can I sort queries by when they were created?
      instructions:
      - text: List my Query Service queries.
      - text: List {limit} queries ordered by {orderby}.
        slots:
          limit: query.limit
          orderby: query.orderby
      - text: List queries matching {property} including soft-deleted ones set to {excludeSoftDeleted}.
        slots:
          property: query.property
          excludeSoftDeleted: query.excludeSoftDeleted
      method: generated
      generated: '2026-09-26'
- target: $.paths['/queries'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a new SQL query
      effect: write
      questions:
      - How do I run a SQL query against my data lake through Query Service?
      - Can I run a query from a saved template instead of raw SQL?
      - Can a query write its results into a new table?
      instructions:
      - text: Run SQL {sql} against database {dbName}.
        slots:
          sql: requestBody.sql
          dbName: requestBody.dbName
      - text: Run query template {templateId} with parameters {queryParameters}.
        slots:
          templateId: requestBody.templateId
          queryParameters: requestBody.queryParameters
      - text: Run {sql} as a CTAS query using {ctasParameters}.
        slots:
          sql: requestBody.sql
          ctasParameters: requestBody.ctasParameters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/queries/{queryid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a query's details and state
      effect: read
      questions:
      - How do I check the status of a query I submitted?
      - Can I see the SQL and state for a specific query ID?
      instructions:
      - text: Show query {queryid}.
        slots:
          queryid: path.queryid
      - text: Check whether query {queryid} has finished.
        slots:
          queryid: path.queryid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/queries/{queryid}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Cancel or soft-delete a query
      effect: destructive
      questions:
      - How do I stop a long-running SQL query?
      - Can I soft delete a query so it no longer shows in my list?
      instructions:
      - text: Cancel query {queryid}.
        slots:
          queryid: path.queryid
      - text: Apply operation {op} to query {queryid}.
        slots:
          op: requestBody.op
          queryid: path.queryid
      method: generated
      generated: '2026-09-26'