Treasure Data · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Treasure Data Tables API
17 actions
17 updates
phrasing
extends
openapi/treasure-data-tables-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Treasure Data's API. It is a proposal applied on top of the contract, not a document Treasure Data publishes.
What the actions change
x-apievangelist-phrasing
Targets 17 · first 16 shown; the file carries all of them
$.info
$.paths['/table/list/{database_name}'].get
$.paths['/table/show/{database_name}/{table_name}'].get
$.paths['/table/delete/{database_name}/{table_name}'].post
$.paths['/table/create/{database_name}/{table_name}/{table_type}'].post
$.paths['/table/create/{database_name}/{table_name}'].post
$.paths['/table/update/{database_name}/{table_name}'].post
$.paths['/table/rename/{database_name}/{current_table_name}/{new_table_name}'].post
$.paths['/table/swap/{database_name}/{table_name_1}/{table_name_2}'].post
$.paths['/table/tail/{database_name}/{table_name}{path_format}'].get
$.paths['/table/distribution/{database_name}/{table_name}'].get
$.paths['/table/change_database/{database_name}/{table_name}'].post
$.paths['/table/transfer/{database_name}/{table_name}'].post
$.paths['/table/append-schema/{database_name}/{table_name}'].post
$.paths['/table/update-schema/{database_name}/{table_name}'].post
$.paths['/table/deleted'].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 Treasure Data Tables API
version: 1.0.0
extends: openapi/treasure-data-tables-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: 16
- target: $.paths['/table/list/{database_name}'].get
update:
x-apievangelist-phrasing:
intent: List the tables in a database
effect: read
questions:
- Which tables exist inside one of my Treasure Data databases?
- Can I see every table a given database holds before I write a query?
instructions:
- text: List all tables in database {database_name}.
slots:
database_name: path.database_name
- text: Show me what tables live in the {database_name} database.
slots:
database_name: path.database_name
method: generated
generated: '2026-09-26'
- target: $.paths['/table/show/{database_name}/{table_name}'].get
update:
x-apievangelist-phrasing:
intent: Show the details of one table
effect: read
questions:
- What schema, row count and settings does a specific table have?
- Can I get a single table's details including its column descriptions?
instructions:
- text: Show table {table_name} in database {database_name}.
slots:
table_name: path.table_name
database_name: path.database_name
- text: Get the details of {database_name}.{table_name}, include_descriptions={include_descriptions}.
slots:
database_name: path.database_name
table_name: path.table_name
include_descriptions: query.include_descriptions
method: generated
generated: '2026-09-26'
- target: $.paths['/table/delete/{database_name}/{table_name}'].post
update:
x-apievangelist-phrasing:
intent: Delete a table
effect: destructive
questions:
- How do I drop a table I no longer need from a database?
- Is it possible to get rid of an old table entirely?
instructions:
- text: Delete table {table_name} from database {database_name}.
slots:
table_name: path.table_name
database_name: path.database_name
- text: Drop the {database_name}.{table_name} table.
slots:
database_name: path.database_name
table_name: path.table_name
method: generated
generated: '2026-09-26'
- target: $.paths['/table/create/{database_name}/{table_name}/{table_type}'].post
update:
x-apievangelist-phrasing:
intent: Create a table with an explicit table type
effect: write
questions:
- Can I create a table and state its table type in the request path?
- Which table type can I pass when creating a table with an explicit type?
instructions:
- text: Create a {table_type} table named {table_name} in database {database_name}.
slots:
table_type: path.table_type
table_name: path.table_name
database_name: path.database_name
- text: Create table {table_name} of type {table_type} in {database_name}, copying properties from {source_table}.
slots:
table_name: path.table_name
table_type: path.table_type
database_name: path.database_name
source_table: query.source_table
method: generated
generated: '2026-09-26'
- target: $.paths['/table/create/{database_name}/{table_name}'].post
update:
x-apievangelist-phrasing:
intent: Create a table with the default log type
effect: write
questions:
- How do I create a new table in a database without choosing a table type?
- Can a new table expire its data after a set number of days?
instructions:
- text: Create a new table {table_name} in database {database_name} using the default type.
slots:
table_name: path.table_name
database_name: path.database_name
- text: Create table {table_name} in {database_name} that expires data after {expire_days} days.
slots:
table_name: path.table_name
database_name: path.database_name
expire_days: requestBody.expire_days
method: generated
generated: '2026-09-26'
- target: $.paths['/table/update/{database_name}/{table_name}'].post
update:
x-apievangelist-phrasing:
intent: Update a table's settings
effect: write
questions:
- Can I change a table's description or data expiration after it was created?
- Is there a way to turn on schema detection for an existing table?
instructions:
- text: Update the description of table {table_name} in {database_name} to {description}.
slots:
table_name: path.table_name
database_name: path.database_name
description: requestBody.description
- text: Set the expiration of {database_name}.{table_name} to {expire_days} days.
slots:
database_name: path.database_name
table_name: path.table_name
expire_days: requestBody.expire_days
method: generated
generated: '2026-09-26'
- target: $.paths['/table/rename/{database_name}/{current_table_name}/{new_table_name}'].post
update:
x-apievangelist-phrasing:
intent: Rename a table
effect: write
questions:
- How do I give an existing table a new name?
- Can I rename a table without moving it to another database?
instructions:
- text: Rename table {current_table_name} in {database_name} to {new_table_name}.
slots:
current_table_name: path.current_table_name
database_name: path.database_name
new_table_name: path.new_table_name
- text: Change the name of the {current_table_name} table in {database_name} to {new_table_name}.
slots:
current_table_name: path.current_table_name
database_name: path.database_name
new_table_name: path.new_table_name
method: generated
generated: '2026-09-26'
- target: $.paths['/table/swap/{database_name}/{table_name_1}/{table_name_2}'].post
update:
x-apievangelist-phrasing:
intent: Swap two tables in a database
effect: write
questions:
- Can I swap two tables so each takes the other's name?
- Is there a way to switch a staging table into place with the live table?
instructions:
- text: Swap tables {table_name_1} and {table_name_2} in database {database_name}.
slots:
table_name_1: path.table_name_1
table_name_2: path.table_name_2
database_name: path.database_name
- text: Exchange the names of {table_name_1} and {table_name_2} in {database_name} so the new one goes live.
slots:
table_name_1: path.table_name_1
table_name_2: path.table_name_2
database_name: path.database_name
method: generated
generated: '2026-09-26'
- target: $.paths['/table/tail/{database_name}/{table_name}{path_format}'].get
update:
x-apievangelist-phrasing:
intent: Show the latest record in a table
effect: read
questions:
- What is the most recent record written to a table?
- Can I peek at the last row of a table in a specific output format?
instructions:
- text: Tail table {table_name} in {database_name} using path format {path_format}.
slots:
table_name: path.table_name
database_name: path.database_name
path_format: path.path_format
- text: Show the last record of {database_name}.{table_name}{path_format} formatted as {format}.
slots:
database_name: path.database_name
table_name: path.table_name
path_format: path.path_format
format: query.format
method: generated
generated: '2026-09-26'
- target: $.paths['/table/distribution/{database_name}/{table_name}'].get
update:
x-apievangelist-phrasing:
intent: Get a table's distribution
effect: read
questions:
- How is a table's data distributed?
- Can I retrieve the distribution settings for one table?
instructions:
- text: Get the distribution of table {table_name} in {database_name}.
slots:
table_name: path.table_name
database_name: path.database_name
- text: Show how {database_name}.{table_name} is distributed.
slots:
database_name: path.database_name
table_name: path.table_name
method: generated
generated: '2026-09-26'
- target: $.paths['/table/change_database/{database_name}/{table_name}'].post
update:
x-apievangelist-phrasing:
intent: Move a table to another database
effect: write
questions:
- Can I move a table from one database into another in my account?
- How do I relocate a table to a different database?
instructions:
- text: Move table {table_name} from {database_name} into database {dest_database_name}.
slots:
table_name: path.table_name
database_name: path.database_name
dest_database_name: requestBody.dest_database_name
- text: Relocate {database_name}.{table_name} to the {dest_database_name} database in this account.
slots:
table_name: path.table_name
database_name: path.database_name
dest_database_name: requestBody.dest_database_name
method: generated
generated: '2026-09-26'
- target: $.paths['/table/transfer/{database_name}/{table_name}'].post
update:
x-apievangelist-phrasing:
intent: Transfer a table to a different account
effect: write
questions:
- Is it possible to hand a table over to a different Treasure Data account?
- What destination details do I need to transfer a table to another account?
instructions:
- text: Transfer {database_name}.{table_name} to another account as {dest_database_name}.{dest_table_name}.
slots:
database_name: path.database_name
table_name: path.table_name
dest_database_name: requestBody.dest_database_name
dest_table_name: requestBody.dest_table_name
- text: Hand table {table_name} from {database_name} over to another account's {dest_database_name} database as {dest_table_name}.
slots:
database_name: path.database_name
table_name: path.table_name
dest_database_name: requestBody.dest_database_name
dest_table_name: requestBody.dest_table_name
method: generated
generated: '2026-09-26'
- target: $.paths['/table/append-schema/{database_name}/{table_name}'].post
update:
x-apievangelist-phrasing:
intent: Append columns to a table's schema
effect: write
questions:
- Can I add new columns to a table's schema while keeping the existing ones?
- How do I extend a table schema with extra fields?
instructions:
- text: Append columns {schema} to the schema of {database_name}.{table_name}.
slots:
schema: requestBody.schema
database_name: path.database_name
table_name: path.table_name
- text: Add the new columns {schema} to table {table_name} in {database_name} without touching existing columns.
slots:
schema: requestBody.schema
database_name: path.database_name
table_name: path.table_name
method: generated
generated: '2026-09-26'
- target: $.paths['/table/update-schema/{database_name}/{table_name}'].post
update:
x-apievangelist-phrasing:
intent: Replace a table's schema
effect: write
questions:
- Can I redefine a table's whole schema, including column descriptions?
- What format do column descriptions take when rewriting a table schema?
instructions:
- text: Replace the schema of {database_name}.{table_name} with {schema}.
slots:
database_name: path.database_name
table_name: path.table_name
schema: requestBody.schema
- text: Overwrite the schema of table {table_name} in {database_name} with {schema}.
slots:
database_name: path.database_name
table_name: path.table_name
schema: requestBody.schema
method: generated
generated: '2026-09-26'
- target: $.paths['/table/deleted'].get
update:
x-apievangelist-phrasing:
intent: List deleted tables that can be recovered
effect: read
questions:
- Which deleted tables can I still recover?
- Can I narrow the recoverable deleted tables to one database?
instructions:
- text: List my recoverable deleted tables.
- text: Show deleted tables from database {database_id}, {page_size} per page.
slots:
database_id: query.database_id
page_size: query.page_size
method: generated
generated: '2026-09-26'
- target: $.paths['/table/recover/{table_id}'].post
update:
x-apievangelist-phrasing:
intent: Recover a deleted table
effect: write
questions:
- How do I restore a table I deleted by mistake?
- Does recovering a table also bring back its deleted parent database?
instructions:
- text: Recover deleted table {table_id}.
slots:
table_id: path.table_id
- text: Restore deleted table {table_id} under the name {table_name}.
slots:
table_id: path.table_id
table_name: requestBody.table_name
method: generated
generated: '2026-09-26'