CData · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/cdata-log-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['/log/query/list'].post

$.paths['/log/query/get/{queryId}'].get

$.paths['/log/audit/list'].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 Log API
  version: 1.0.0
extends: openapi/cdata-log-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: 3
- target: $.paths['/log/query/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List query logs for the account
      effect: read
      questions:
      - Which queries ran against my Connect AI account in a given time window?
      - Can I filter the query history by query type?
      - How do I review recent query activity for troubleshooting?
      instructions:
      - text: List query logs between {startTime} and {endTime}.
        slots:
          startTime: requestBody.startTime
          endTime: requestBody.endTime
      - text: Show the query history of type {queryType}.
        slots:
          queryType: requestBody.queryType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/log/query/get/{queryId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the log file for one query
      effect: read
      questions:
      - How do I download the detailed log file for a query that failed?
      - Can I get the troubleshooting log for a specific query Id?
      instructions:
      - text: Download the log file for query {queryId}.
        slots:
          queryId: path.queryId
      - text: Fetch the troubleshooting log of query {queryId}.
        slots:
          queryId: path.queryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/log/audit/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List audit log entries for the account
      effect: read
      questions:
      - Who changed what in our account, and can I see an audit trail for it?
      - Can I pull audit events for a specific UTC date range?
      instructions:
      - text: List audit log entries from {startTime} to {endTime}.
        slots:
          startTime: query.startTime
          endTime: query.endTime
      - text: Show me the account's audit trail.
      method: generated
      generated: '2026-09-26'