Adobe Experience Cloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Experience Cloud Adobe Experience Platform Queries API

4 actions 4 updates phrasing extends openapi/adobe-experience-cloud-queries-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/data/foundation/query/queries'].get

$.paths['/data/foundation/query/queries'].post

$.paths['/data/foundation/query/queries/{queryId}'].get

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 Adobe Experience Cloud Adobe Experience Platform Queries API
  version: 1.0.0
extends: openapi/adobe-experience-cloud-queries-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: 3
- target: $.paths['/data/foundation/query/queries'].get
  update:
    x-apievangelist-phrasing:
      intent: List submitted SQL queries
      effect: read
      questions:
      - Which SQL queries have been run against Query Service recently?
      - Can I see the status of every query submitted in a sandbox?
      instructions:
      - text: List queries in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Show the last {limit} Query Service queries.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data/foundation/query/queries'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a SQL query on the Data Lake
      effect: write
      questions:
      - How do I run SQL against my Experience Platform datasets?
      - Does submitting a query return results right away or an ID to poll?
      instructions:
      - text: Run SQL {sql} against database {dbName}.
        slots:
          sql: requestBody.sql
          dbName: requestBody.dbName
      - text: Submit query {name} with SQL {sql} on database {dbName} in sandbox {sandbox}.
        slots:
          name: requestBody.name
          sql: requestBody.sql
          dbName: requestBody.dbName
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data/foundation/query/queries/{queryId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a submitted query's status
      effect: read
      questions:
      - Has my Query Service query finished yet?
      - Where do I find the results reference for a query I already submitted?
      instructions:
      - text: Check the status of query {queryId}.
        slots:
          queryId: path.queryId
      - text: Get execution details for query {queryId} in sandbox {sandbox}.
        slots:
          queryId: path.queryId
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-10-01'