Treasure Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for llm-api Plazma Query Tool API

5 actions 5 updates phrasing extends openapi/treasure-data-plazmaquerytool-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['/api/plazma_query_tools'].post

$.paths['/api/plazma_query_tools/{id}'].get

$.paths['/api/plazma_query_tools/{id}'].delete

$.paths['/api/plazma_query_tools/{id}'].patch

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 llm-api Plazma Query Tool API
  version: 1.0.0
extends: openapi/treasure-data-plazmaquerytool-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: 4
- target: $.paths['/api/plazma_query_tools'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Plazma query tool
      effect: write
      questions:
      - Can I let an AI agent run queries against my Plazma data?
      - What does it take to create a Plazma query tool?
      instructions:
      - text: Create a Plazma query tool with {data}.
        slots:
          data: requestBody.data
      - text: Add a new query tool over Plazma for my agents using {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/plazma_query_tools/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Plazma query tool
      effect: read
      questions:
      - How is a particular Plazma query tool set up?
      - Can I look up one Plazma query tool by ID?
      instructions:
      - text: Show Plazma query tool {id}.
        slots:
          id: path.id
      - text: Fetch the configuration of Plazma query tool {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/plazma_query_tools/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Plazma query tool
      effect: destructive
      questions:
      - How do I remove a Plazma query tool from my agents?
      - Is deleting a Plazma query tool permanent?
      instructions:
      - text: Delete Plazma query tool {id}.
        slots:
          id: path.id
      - text: Remove the unused Plazma query tool {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/plazma_query_tools/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Plazma query tool
      effect: write
      questions:
      - Can I change the settings of an existing Plazma query tool?
      - What can I edit on a Plazma query tool?
      instructions:
      - text: Update Plazma query tool {id} with {data}.
        slots:
          id: path.id
          data: requestBody.data
      - text: Edit the configuration of existing Plazma query tool {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'