Treasure Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Treasure Data Connections API

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

$.info
$.paths['/result/list'].get
$.paths['/result/create/{connection_name}'].post
$.paths['/result/delete/{connection_name}'].post
$.paths['/connections/lookup'].get
$.paths['/connector_configs/validate_with_connection'].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 Connections API
  version: 1.0.0
extends: openapi/treasure-data-connections-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: 5
- target: $.paths['/result/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List result output connections
      effect: read
      questions:
      - What result output connections have I set up?
      - Where can I see all saved connections for exporting query results?
      instructions:
      - text: List my connections.
      - text: Show all saved result output connections.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/result/create/{connection_name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a result output connection
      effect: write
      questions:
      - How do I save a new connection for writing query results somewhere?
      - Can I create a connection from a result URL?
      instructions:
      - text: Create connection {connection_name} with URL {url}.
        slots:
          connection_name: path.connection_name
          url: requestBody.url
      - text: Save a new result connection called {connection_name}.
        slots:
          connection_name: path.connection_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/result/delete/{connection_name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a result output connection
      effect: destructive
      questions:
      - How do I remove a saved connection?
      - Can I delete a connection by its name?
      instructions:
      - text: Delete connection {connection_name}.
        slots:
          connection_name: path.connection_name
      - text: Remove the saved connection named {connection_name}.
        slots:
          connection_name: path.connection_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connections/lookup'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a connection's ID by name
      effect: read
      questions:
      - What's the ID of the connection I named a certain way?
      - Can I find a connection's ID if I only know its name?
      instructions:
      - text: Look up the ID of connection {name}.
        slots:
          name: query.name
      - text: Find the connection ID for the connection named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connector_configs/validate_with_connection'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a connector configuration
      effect: read
      questions:
      - Can I check that connector settings are valid before saving them?
      - How do I test a connector config against an existing connection?
      instructions:
      - text: Validate {type} connector settings {settings} against connection {connection_id}.
        slots:
          type: requestBody.type
          settings: requestBody.settings
          connection_id: requestBody.connection_id
      - text: Check connector config {settings} is valid before saving it.
        slots:
          settings: requestBody.settings
      method: generated
      generated: '2026-09-26'