CData · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for CData Connect AI OpenAPI API

2 actions 2 updates phrasing extends openapi/cdata-open-api-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 2

$.info
$.paths['/{version}/{workspaceName}'].get

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 CData Connect AI OpenAPI API
  version: 1.0.0
extends: openapi/cdata-open-api-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: 1
- target: $.paths['/{version}/{workspaceName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an OpenAPI document for a workspace
      effect: read
      questions:
      - Can I export an OpenAPI description of my CData Connect AI workspace for a low-code tool?
      - Which OpenAPI versions can a workspace document be generated in?
      - Is there a way to have array fields rendered as strings in the generated spec?
      instructions:
      - text: Download the OpenAPI {version} document for workspace {workspaceName}.
        slots:
          version: path.version
          workspaceName: path.workspaceName
      - text: Generate the OpenAPI {version} spec for {workspaceName} with arrays converted to strings set to {convertArraysToStrings}.
        slots:
          version: path.version
          workspaceName: path.workspaceName
          convertArraysToStrings: query.convertArraysToStrings
      method: generated
      generated: '2026-10-02'