CData · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for CData Connect AI O Data API

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

$.info

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

$.paths['/{workspaceName}/$metadata'].get

$.paths['/{workspaceName}/{resourcePath}'].get

$.paths['/{workspaceName}/{resourcePath}'].post

$.paths['/{workspaceName}/{resourcePath}'].delete

$.paths['/{workspaceName}/{resourcePath}'].patch

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 O Data API
  version: 1.0.0
extends: openapi/cdata-odata-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: 6
- target: $.paths['/{workspaceName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workspace's OData service root
      effect: read
      questions:
      - What OData resources does a CData Connect AI workspace expose?
      - Where is the OData service document listing a workspace's entity sets?
      instructions:
      - text: Get the OData service root for workspace {workspaceName}.
        slots:
          workspaceName: path.workspaceName
      - text: List the OData resources available in workspace {workspaceName}.
        slots:
          workspaceName: path.workspaceName
      method: generated
      generated: '2026-10-02'
- target: $.paths['/{workspaceName}/$metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the OData $metadata document for a workspace
      effect: read
      questions:
      - How do I download the OData $metadata describing a workspace's entity types?
      - Can I get the full EDM schema document for an OData workspace?
      instructions:
      - text: Fetch the $metadata document for workspace {workspaceName}.
        slots:
          workspaceName: path.workspaceName
      - text: Show the OData entity model metadata of workspace {workspaceName}.
        slots:
          workspaceName: path.workspaceName
      method: generated
      generated: '2026-10-02'
- target: $.paths['/{workspaceName}/{resourcePath}'].get
  update:
    x-apievangelist-phrasing:
      intent: Query records from an OData resource
      effect: read
      questions:
      - How do I read rows from a table through the OData endpoint?
      - Can I apply OData filters when querying a workspace resource?
      instructions:
      - text: Query OData resource {resourcePath} in workspace {workspaceName}.
        slots:
          resourcePath: path.resourcePath
          workspaceName: path.workspaceName
      - text: Read the records at {resourcePath} from workspace {workspaceName} over OData.
        slots:
          resourcePath: path.resourcePath
          workspaceName: path.workspaceName
      method: generated
      generated: '2026-10-02'
- target: $.paths['/{workspaceName}/{resourcePath}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a record through OData
      effect: write
      questions:
      - How do I insert a new record into a table using OData?
      - Can I add rows to a connected data source through the OData API?
      instructions:
      - text: Create a new record in OData resource {resourcePath} of workspace {workspaceName}.
        slots:
          resourcePath: path.resourcePath
          workspaceName: path.workspaceName
      - text: Insert a row into {resourcePath} in workspace {workspaceName} via OData.
        slots:
          resourcePath: path.resourcePath
          workspaceName: path.workspaceName
      method: generated
      generated: '2026-10-02'
- target: $.paths['/{workspaceName}/{resourcePath}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a record through OData
      effect: destructive
      questions:
      - How do I remove a record from a connected source using OData?
      - Is deleting an OData entity permanent in the underlying data source?
      instructions:
      - text: Delete the OData entity at {resourcePath} in workspace {workspaceName}.
        slots:
          resourcePath: path.resourcePath
          workspaceName: path.workspaceName
      - text: Remove record {resourcePath} from workspace {workspaceName} over OData.
        slots:
          resourcePath: path.resourcePath
          workspaceName: path.workspaceName
      method: generated
      generated: '2026-10-02'
- target: $.paths['/{workspaceName}/{resourcePath}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a record through OData
      effect: write
      questions:
      - How do I change fields on an existing record via OData?
      - Can I partially update an entity in my workspace instead of replacing it?
      instructions:
      - text: Update the existing OData entity at {resourcePath} in workspace {workspaceName}.
        slots:
          resourcePath: path.resourcePath
          workspaceName: path.workspaceName
      - text: Patch fields on record {resourcePath} in workspace {workspaceName}.
        slots:
          resourcePath: path.resourcePath
          workspaceName: path.workspaceName
      method: generated
      generated: '2026-10-02'