CData · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for CData Connect AI REST API Embedded Query API

4 actions 4 updates phrasing extends openapi/cdata-query-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/query'].post

$.paths['/batch'].post

$.paths['/exec'].post

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 CData Connect AI REST API Embedded Query API
  version: 1.0.0
extends: openapi/cdata-query-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a SQL query against my data sources
      effect: write
      questions:
      - How do I run a SQL SELECT across the data sources in my CData Connect AI account?
      - Can I get just the result set schema without any data rows?
      - Which SQL statements can a single query request run?
      instructions:
      - text: Run the SQL query {query}.
        slots:
          query: requestBody.query
      - text: Run {query} using default catalog {defaultCatalog} and return only the result schema when schemaOnly is {schemaOnly}.
        slots:
          query: requestBody.query
          defaultCatalog: requestBody.defaultCatalog
          schemaOnly: requestBody.schemaOnly
      method: generated
      generated: '2026-10-02'
- target: $.paths['/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Run batch inserts, updates or deletes
      effect: write
      questions:
      - Can I insert many rows in one request instead of one query per row?
      - What is the way to apply a batch of updates or deletes to a data source?
      instructions:
      - text: Execute the batch statement {query} with parameter sets {parameters}.
        slots:
          query: requestBody.query
          parameters: requestBody.parameters
      - text: Bulk-run the INSERT, UPDATE or DELETE {query} in schema {defaultSchema} as a batch.
        slots:
          query: requestBody.query
          defaultSchema: requestBody.defaultSchema
      method: generated
      generated: '2026-10-02'
- target: $.paths['/exec'].post
  update:
    x-apievangelist-phrasing:
      intent: Execute a stored procedure
      effect: write
      questions:
      - How do I call a stored procedure on one of my connected data sources?
      - Can I pass input parameters to a stored procedure call?
      instructions:
      - text: Execute stored procedure {procedure}.
        slots:
          procedure: requestBody.procedure
      - text: Call procedure {procedure} in catalog {defaultCatalog} with parameters {parameters}.
        slots:
          procedure: requestBody.procedure
          defaultCatalog: requestBody.defaultCatalog
          parameters: requestBody.parameters
      method: generated
      generated: '2026-10-02'