Treasure Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Treasure Data Databases API

5 actions 5 updates phrasing extends openapi/treasure-data-databases-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 5

$.info
$.paths['/database/list'].get
$.paths['/database/show/{database_name}'].get
$.paths['/database/create/{database_name}'].post
$.paths['/database/delete/{database_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 Databases API
  version: 1.0.0
extends: openapi/treasure-data-databases-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: 4
- target: $.paths['/database/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List databases
      effect: read
      questions:
      - What databases are in my Treasure Data account?
      - Can I get every database I have?
      instructions:
      - text: List all databases.
      - text: Show every database in my account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/database/show/{database_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a database by name
      effect: read
      questions:
      - How do I see details about one database?
      - Can I check my permissions on a specific database?
      instructions:
      - text: Show database {database_name}.
        slots:
          database_name: path.database_name
      - text: Show database {database_name} including permissions ({require_permissions}).
        slots:
          database_name: path.database_name
          require_permissions: query.require_permissions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/database/create/{database_name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a database
      effect: write
      questions:
      - How do I create a new database?
      - Can I add a database by name through the API?
      instructions:
      - text: Create database {database_name}.
        slots:
          database_name: path.database_name
      - text: Add a new empty database called {database_name}.
        slots:
          database_name: path.database_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/database/delete/{database_name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a database
      effect: destructive
      questions:
      - How do I delete a database I don't need anymore?
      - Can I drop a whole database by name?
      instructions:
      - text: Delete database {database_name}.
        slots:
          database_name: path.database_name
      - text: Drop the database named {database_name}.
        slots:
          database_name: path.database_name
      method: generated
      generated: '2026-09-26'