CData · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/cdata-account-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 6

$.info
$.paths['/poweredby/account/list'].get
$.paths['/poweredby/account/{accountIdOrExternalId}'].get
$.paths['/poweredby/account/create'].post
$.paths['/poweredby/account/update/{subAccountId}'].put
$.paths['/poweredby/account/delete/{id}'].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 CData Connect AI REST API Embedded Account API
  version: 1.0.0
extends: openapi/cdata-account-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: 5
- target: $.paths['/poweredby/account/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List sub-accounts under the parent account
      effect: read
      questions:
      - How do I see every sub-account under my Connect AI Embed parent account?
      - Which customer sub-accounts have I provisioned so far?
      - Can I pull the full roster of embedded tenant accounts in one call?
      instructions:
      - text: List all the sub-accounts under my parent account.
      - text: Show me every embedded customer sub-account we have provisioned.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/poweredby/account/{accountIdOrExternalId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one sub-account by Id or external Id
      effect: read
      questions:
      - Can I look up a sub-account using my own external Id instead of the Connect AI Id?
      - What details come back for a single embedded sub-account?
      - How do I fetch one customer's sub-account record?
      instructions:
      - text: Get the sub-account {accountIdOrExternalId}.
        slots:
          accountIdOrExternalId: path.accountIdOrExternalId
      - text: Look up the sub-account whose external Id is {accountIdOrExternalId}.
        slots:
          accountIdOrExternalId: path.accountIdOrExternalId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/poweredby/account/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a sub-account for an embedded customer
      effect: write
      questions:
      - How do I provision a new sub-account for a customer in Connect AI Embed?
      - Can I create a sub-account with an empty body and fill in the name later?
      - Is it possible to tag a new sub-account with my own external Id when creating it?
      instructions:
      - text: Create a new sub-account named {accountName} with external Id {externalId}.
        slots:
          accountName: requestBody.accountName
          externalId: requestBody.externalId
      - text: Provision a blank sub-account for a new customer.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/poweredby/account/update/{subAccountId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or re-key an existing sub-account
      effect: write
      questions:
      - How do I rename a sub-account after it has been created?
      - Can I change the external Id on an existing sub-account?
      instructions:
      - text: Rename sub-account {subAccountId} to {accountName}.
        slots:
          subAccountId: path.subAccountId
          accountName: requestBody.accountName
      - text: Change the external Id of sub-account {subAccountId} to {externalId}.
        slots:
          subAccountId: path.subAccountId
          externalId: requestBody.externalId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/poweredby/account/delete/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a sub-account
      effect: destructive
      questions:
      - How do I remove a customer's sub-account from Connect AI Embed?
      - What happens when I delete an embedded sub-account I no longer need?
      instructions:
      - text: Delete sub-account {id}.
        slots:
          id: path.id
      - text: Remove the churned customer's sub-account {id} from the embed product.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'