Treasure Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for First class Data Warehouse Integration Dwh API

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

$.info

$.paths['/v1/dwh/'].get

$.paths['/v1/dwh/'].post

$.paths['/v1/dwh/{dwh_id}'].get

$.paths['/v1/dwh/{dwh_id}'].put

$.paths['/v1/dwh/{dwh_id}'].delete

$.paths['/v1/dwh/{dwh_id}/bulkload_sessions'].get

$.paths['/v1/dwh/{dwh_id}/configs'].get

$.paths['/v1/dwh/{dwh_id}/run_workflow'].put

$.paths['/v1/dwh/{dwh_id}/session_attempts'].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 First class Data Warehouse Integration Dwh API
  version: 1.0.0
extends: openapi/treasure-data-dwh-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/v1/dwh/'].get
  update:
    x-apievangelist-phrasing:
      intent: List data warehouse integrations
      effect: read
      questions:
      - Which data warehouse integrations have I set up?
      - What warehouse syncs exist for my user?
      instructions:
      - text: List my DWH integrations.
      - text: Show all data warehouse integrations for the current user.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/dwh/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a data warehouse integration
      effect: write
      questions:
      - Can I schedule a recurring import from my data warehouse into Treasure Data?
      - Do I need the target database and tables to exist before creating a warehouse integration?
      instructions:
      - text: Create a DWH integration named {name} on a {schedule_type} schedule.
        slots:
          name: requestBody.name
          schedule_type: requestBody.schedule_type
      - text: Create warehouse integration {name} with connection {basic_configs} writing to {output_config} in timezone {timezone}.
        slots:
          name: requestBody.name
          basic_configs: requestBody.basic_configs
          output_config: requestBody.output_config
          timezone: requestBody.timezone
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/dwh/{dwh_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data warehouse integration
      effect: read
      questions:
      - Can I look up one warehouse integration by its ID?
      - What is the status and schedule of a single DWH integration?
      instructions:
      - text: Show DWH integration {dwh_id}.
        slots:
          dwh_id: path.dwh_id
      - text: Get warehouse integration {dwh_id}.
        slots:
          dwh_id: path.dwh_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/dwh/{dwh_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a data warehouse integration
      effect: write
      questions:
      - Can I change the schedule or filters of an existing warehouse integration?
      - Which settings of a DWH integration can be replaced?
      instructions:
      - text: Change the schedule of DWH integration {dwh_id} to {schedule_type} with option {schedule_option}.
        slots:
          dwh_id: path.dwh_id
          schedule_type: requestBody.schedule_type
          schedule_option: requestBody.schedule_option
      - text: Update filters of warehouse integration {dwh_id} to {filter_configs}.
        slots:
          dwh_id: path.dwh_id
          filter_configs: requestBody.filter_configs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/dwh/{dwh_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data warehouse integration
      effect: destructive
      questions:
      - What gets removed when I delete a warehouse integration?
      - Can I tear down a DWH integration along with its generated workflow?
      instructions:
      - text: Delete DWH integration {dwh_id}.
        slots:
          dwh_id: path.dwh_id
      - text: Destroy warehouse integration {dwh_id} and its generated workflow and bulkload sessions.
        slots:
          dwh_id: path.dwh_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/dwh/{dwh_id}/bulkload_sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a warehouse integration's bulkload sessions
      effect: read
      questions:
      - Which bulkload sessions did a warehouse integration generate?
      - Can I see the import sessions behind one DWH integration?
      instructions:
      - text: List bulkload sessions of DWH integration {dwh_id}.
        slots:
          dwh_id: path.dwh_id
      - text: Show the generated import sessions for warehouse integration {dwh_id}.
        slots:
          dwh_id: path.dwh_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/dwh/{dwh_id}/configs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a warehouse integration's configuration
      effect: read
      questions:
      - What connection and output configuration does a warehouse integration use?
      - Can I read back the full config of one DWH integration?
      instructions:
      - text: Get the configuration of DWH integration {dwh_id}.
        slots:
          dwh_id: path.dwh_id
      - text: Show config details for warehouse integration {dwh_id}.
        slots:
          dwh_id: path.dwh_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/dwh/{dwh_id}/run_workflow'].put
  update:
    x-apievangelist-phrasing:
      intent: Run a warehouse integration now
      effect: write
      questions:
      - Can I trigger a warehouse import immediately instead of waiting for its schedule?
      - What kicks off the workflow behind a DWH integration on demand?
      instructions:
      - text: Run the workflow for DWH integration {dwh_id} now.
        slots:
          dwh_id: path.dwh_id
      - text: Trigger an immediate sync of warehouse integration {dwh_id}.
        slots:
          dwh_id: path.dwh_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/dwh/{dwh_id}/session_attempts'].get
  update:
    x-apievangelist-phrasing:
      intent: List a warehouse integration's workflow attempts
      effect: read
      questions:
      - Did the recent workflow runs of my warehouse integration succeed?
      - Can I see each workflow session attempt for a DWH integration?
      instructions:
      - text: List workflow session attempts of DWH integration {dwh_id}.
        slots:
          dwh_id: path.dwh_id
      - text: Show recent run attempts for warehouse integration {dwh_id}.
        slots:
          dwh_id: path.dwh_id
      method: generated
      generated: '2026-10-01'