Treasure Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Treasure Data TD Bulk Import API

11 actions 11 updates phrasing extends openapi/treasure-data-bulk-import-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.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 11

$.info
$.paths['/bulk_import/list'].get
$.paths['/bulk_import/create/{name}/{database_name}/{table_name}'].post
$.paths['/bulk_import/show/{name}'].get
$.paths['/bulk_import/upload_part/{name}'].put
$.paths['/bulk_import/list_parts/{name}'].get
$.paths['/bulk_import/perform/{name}'].post
$.paths['/bulk_import/commit/{name}'].post
$.paths['/bulk_import/freeze/{name}'].post
$.paths['/bulk_import/unfreeze/{name}'].post
$.paths['/bulk_import/delete/{name}'].post

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 Treasure Data TD Bulk Import API
  version: 1.0.0
extends: openapi/treasure-data-bulk-import-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: 10
- target: $.paths['/bulk_import/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List bulk import sessions
      effect: read
      questions:
      - What bulk import sessions are open in my account?
      - Where can I see all my bulk import sessions?
      instructions:
      - text: List my bulk import sessions.
      - text: Show every bulk import session in the account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk_import/create/{name}/{database_name}/{table_name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a bulk import session for a table
      effect: write
      questions:
      - How do I start a bulk import into a Treasure Data table?
      - Can I create a named import session that targets a specific database and table?
      instructions:
      - text: Create bulk import session {name} into table {table_name} of database {database_name}.
        slots:
          name: path.name
          table_name: path.table_name
          database_name: path.database_name
      - text: Open a new bulk import named {name} loading into {database_name}.{table_name}.
        slots:
          name: path.name
          database_name: path.database_name
          table_name: path.table_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk_import/show/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a bulk import session's details
      effect: read
      questions:
      - What state is my bulk import session in?
      - Can I see details about one bulk import session?
      instructions:
      - text: Show bulk import session {name}.
        slots:
          name: path.name
      - text: Get the status and details of bulk import {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk_import/upload_part/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload a msgpack.gz part to a bulk import
      effect: write
      questions:
      - How do I upload a msgpack.gz file into a bulk import session?
      - Can I send data to a bulk import in multiple parts?
      instructions:
      - text: Upload a part to bulk import session {name}.
        slots:
          name: path.name
      - text: Add a msgpack.gz file as a new part of bulk import {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk_import/list_parts/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: List uploaded parts of a bulk import
      effect: read
      questions:
      - Which parts have already been uploaded to my bulk import?
      - Can I check which files made it into a bulk import session?
      instructions:
      - text: List the uploaded parts of bulk import {name}.
        slots:
          name: path.name
      - text: Show which parts bulk import session {name} has received.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk_import/perform/{name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Run the bulk import job for a session
      effect: write
      questions:
      - How do I process the parts I've uploaded to a bulk import?
      - What step converts uploaded bulk import parts before committing?
      instructions:
      - text: Perform bulk import {name}.
        slots:
          name: path.name
      - text: Process the uploaded parts of bulk import session {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk_import/commit/{name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Commit a bulk import to make data available
      effect: write
      questions:
      - How do I finalize a bulk import so the data shows up in the table?
      - What's the last step to publish bulk-imported data?
      instructions:
      - text: Commit bulk import {name}.
        slots:
          name: path.name
      - text: Finalize bulk import session {name} so its data lands in the table.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk_import/freeze/{name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Freeze a bulk import to block more uploads
      effect: write
      questions:
      - Can I stop further uploads to a bulk import session?
      - How do I lock a bulk import once all parts are in?
      instructions:
      - text: Freeze bulk import session {name}.
        slots:
          name: path.name
      - text: Block any more uploads to bulk import {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk_import/unfreeze/{name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Unfreeze a bulk import to allow uploads
      effect: write
      questions:
      - How do I reopen a frozen bulk import so I can upload more parts?
      - Can a frozen import session accept uploads again?
      instructions:
      - text: Unfreeze bulk import session {name}.
        slots:
          name: path.name
      - text: Allow uploads again on frozen bulk import {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk_import/delete/{name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a bulk import session
      effect: destructive
      questions:
      - How do I throw away a bulk import session I don't need?
      - Can I remove an abandoned bulk import?
      instructions:
      - text: Delete bulk import session {name}.
        slots:
          name: path.name
      - text: Discard bulk import {name} and its session.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'