Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Query Service Query Templates API

7 actions 7 updates phrasing extends openapi/adobe-suite-query-templates-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Adobe Suite's API. It is a proposal applied on top of the contract, not a document Adobe Suite publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/query-templates'].get
$.paths['/query-templates'].post
$.paths['/query-templates/count'].get
$.paths['/query-templates/{queryTemplateId}'].get
$.paths['/query-templates/{queryTemplateId}'].put
$.paths['/query-templates/{queryTemplateId}'].delete

OpenAPI Overlay

Raw ↑
# 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 Query Templates API
  version: 1.0.0
extends: openapi/adobe-suite-query-templates-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: 6
- target: $.paths['/query-templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List saved query templates
      effect: read
      questions:
      - Which query templates have we saved in Query Service?
      - Can I page through query templates sorted by a property?
      instructions:
      - text: List query templates in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Show {limit} query templates ordered by {orderby}.
        slots:
          limit: query.limit
          orderby: query.orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/query-templates'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a SQL query as a template
      effect: write
      questions:
      - How do I save a SQL statement as a reusable query template?
      - Can a query template take parameters?
      instructions:
      - text: Create query template {name} with SQL {sql}.
        slots:
          name: requestBody.name
          sql: requestBody.sql
      - text: Save {sql} as template {name} using parameters {params}.
        slots:
          sql: requestBody.sql
          name: requestBody.name
          params: requestBody.queryParameters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/query-templates/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count query templates
      effect: read
      questions:
      - How many query templates exist in this sandbox?
      - Can I count only query templates matching a property filter?
      instructions:
      - text: Count query templates in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Count query templates where {property}.
        slots:
          property: query.property
      method: generated
      generated: '2026-09-26'
- target: $.paths['/query-templates/{queryTemplateId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a query template
      effect: read
      questions:
      - How do I see the SQL stored in a query template?
      - Can I look up one query template by its ID?
      instructions:
      - text: Show query template {template}.
        slots:
          template: path.queryTemplateId
      - text: Get the SQL behind query template {template}.
        slots:
          template: path.queryTemplateId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/query-templates/{queryTemplateId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a query template
      effect: write
      questions:
      - Can I change the SQL in an existing query template?
      - Does updating a template require resending its name and SQL?
      instructions:
      - text: Update query template {template} to SQL {sql}.
        slots:
          template: path.queryTemplateId
          sql: requestBody.sql
      - text: Rename query template {template} to {name} keeping SQL {sql}.
        slots:
          template: path.queryTemplateId
          name: requestBody.name
          sql: requestBody.sql
      method: generated
      generated: '2026-09-26'
- target: $.paths['/query-templates/{queryTemplateId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a query template
      effect: destructive
      questions:
      - How do I remove a saved query template?
      - Can I delete one query template by ID?
      instructions:
      - text: Delete query template {template}.
        slots:
          template: path.queryTemplateId
      - text: Remove the saved template {template}.
        slots:
          template: path.queryTemplateId
      method: generated
      generated: '2026-09-26'