CData · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for CData Connect AI REST API Embedded Metadata API
11 actions
11 updates
phrasing
extends
openapi/cdata-metadata-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.
What the actions change
x-apievangelist-phrasing
Targets 11
$.info
$.paths['/catalogs'].get
$.paths['/schemas'].get
$.paths['/tables'].get
$.paths['/columns'].get
$.paths['/primaryKeys'].get
$.paths['/importedKeys'].get
$.paths['/exportedKeys'].get
$.paths['/indexes'].get
$.paths['/procedures'].get
$.paths['/procedureParameters'].get
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 Metadata API
version: 1.0.0
extends: openapi/cdata-metadata-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: 10
- target: $.paths['/catalogs'].get
update:
x-apievangelist-phrasing:
intent: List the catalogs (connections) in my account
effect: read
questions:
- Which data connections show up as catalogs in my CData Connect AI account?
- What catalogs can I query right now?
instructions:
- text: List all the catalogs available in my account.
- text: Show me every connection exposed as a catalog.
method: generated
generated: '2026-10-02'
- target: $.paths['/schemas'].get
update:
x-apievangelist-phrasing:
intent: List the schemas in a catalog
effect: read
questions:
- What schemas does one of my connected catalogs contain?
- Can I check whether a particular schema exists in a catalog?
instructions:
- text: List the schemas in catalog {catalogName}.
slots:
catalogName: query.catalogName
- text: Check if schema {schemaName} exists in catalog {catalogName}.
slots:
schemaName: query.schemaName
catalogName: query.catalogName
method: generated
generated: '2026-10-02'
- target: $.paths['/tables'].get
update:
x-apievangelist-phrasing:
intent: List tables and views in a schema
effect: read
questions:
- Which tables and views are available in a schema of my connection?
- Can I list only views, or only tables, for a schema?
instructions:
- text: List the tables and views in schema {schemaName} of catalog {catalogName}.
slots:
schemaName: query.schemaName
catalogName: query.catalogName
- text: Show only objects of type {tableType} in schema {schemaName}.
slots:
tableType: query.tableType
schemaName: query.schemaName
method: generated
generated: '2026-10-02'
- target: $.paths['/columns'].get
update:
x-apievangelist-phrasing:
intent: List the columns of a table or view
effect: read
questions:
- What columns does a given table or view have?
- How can I look up the definition of a single column in a table?
instructions:
- text: List the columns of table {tableName}.
slots:
tableName: query.tableName
- text: Describe column {columnName} in table {tableName} of catalog {catalogName}.
slots:
columnName: query.columnName
tableName: query.tableName
catalogName: query.catalogName
method: generated
generated: '2026-10-02'
- target: $.paths['/primaryKeys'].get
update:
x-apievangelist-phrasing:
intent: List a table's primary keys
effect: read
questions:
- Which columns make up the primary key of a table?
- Does this table even have a primary key defined?
instructions:
- text: Show the primary key columns of table {tableName}.
slots:
tableName: query.tableName
- text: Get the primary keys for {tableName} in schema {schemaName}.
slots:
tableName: query.tableName
schemaName: query.schemaName
method: generated
generated: '2026-10-02'
- target: $.paths['/importedKeys'].get
update:
x-apievangelist-phrasing:
intent: List the keys a table's foreign keys reference
effect: read
questions:
- Which other tables does this table point to through its foreign keys?
- What primary keys are referenced by a table's foreign key columns?
instructions:
- text: Show the imported keys that table {tableName}'s foreign keys reference.
slots:
tableName: query.tableName
- text: List which parent tables {tableName} in schema {schemaName} depends on.
slots:
tableName: query.tableName
schemaName: query.schemaName
method: generated
generated: '2026-10-02'
- target: $.paths['/exportedKeys'].get
update:
x-apievangelist-phrasing:
intent: List foreign keys that reference a table
effect: read
questions:
- Which other tables hold foreign keys pointing at this table's primary key?
- What depends on this table through exported keys?
instructions:
- text: 'Show the exported keys: foreign keys elsewhere that reference table {tableName}.'
slots:
tableName: query.tableName
- text: List child tables that reference {tableName} in catalog {catalogName}.
slots:
tableName: query.tableName
catalogName: query.catalogName
method: generated
generated: '2026-10-02'
- target: $.paths['/indexes'].get
update:
x-apievangelist-phrasing:
intent: List the indexes on a table
effect: read
questions:
- What indexes exist on a table in my connection?
- Can I see only the unique indexes for a table?
instructions:
- text: List the indexes on table {tableName}.
slots:
tableName: query.tableName
- text: Show only indexes on {tableName} where unique is {unique}.
slots:
tableName: query.tableName
unique: query.unique
- text: Describe index {indexName} on table {tableName}.
slots:
indexName: query.indexName
tableName: query.tableName
method: generated
generated: '2026-10-02'
- target: $.paths['/procedures'].get
update:
x-apievangelist-phrasing:
intent: List stored procedures in a schema
effect: read
questions:
- Which stored procedures can I run against a connected data source?
- Is a specific stored procedure available in my schema?
instructions:
- text: List the stored procedures in schema {schemaName}.
slots:
schemaName: query.schemaName
- text: Check whether procedure {procedureName} exists in catalog {catalogName}.
slots:
procedureName: query.procedureName
catalogName: query.catalogName
method: generated
generated: '2026-10-02'
- target: $.paths['/procedureParameters'].get
update:
x-apievangelist-phrasing:
intent: List a stored procedure's parameters
effect: read
questions:
- What inputs does a stored procedure expect before I execute it?
- Can I look up the details of one parameter of a procedure?
instructions:
- text: List the parameters of stored procedure {procedureName}.
slots:
procedureName: query.procedureName
- text: Describe parameter {paramName} of procedure {procedureName}.
slots:
paramName: query.paramName
procedureName: query.procedureName
method: generated
generated: '2026-10-02'