Treasure Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Treasure Workflow API

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

$.info

$.paths['/api/workflows'].get

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

$.paths['/api/workflows/{id}/truncated_session_time'].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 Treasure Workflow API
  version: 1.0.0
extends: openapi/treasure-data-workflow-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: 3
- target: $.paths['/api/workflows'].get
  update:
    x-apievangelist-phrasing:
      intent: List workflows across projects
      effect: read
      questions:
      - What workflows exist across all my projects?
      - Can I search workflows by name pattern or project name?
      instructions:
      - text: List all workflows.
      - text: List workflows matching {name_pattern} in projects named {search_project_name}.
        slots:
          name_pattern: query.name_pattern
          search_project_name: query.search_project_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workflow by ID
      effect: read
      questions:
      - How do I read a workflow definition when I know its ID?
      - Can I fetch one workflow without knowing its project?
      instructions:
      - text: Show workflow {id}.
        slots:
          id: path.id
      - text: Get the definition of workflow {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/{id}/truncated_session_time'].get
  update:
    x-apievangelist-phrasing:
      intent: Truncate a time to a workflow's time zone
      effect: read
      questions:
      - How would a session time be truncated in a workflow's local time zone?
      - Can I compute the truncated local session time for a workflow?
      instructions:
      - text: Get truncated session time {session_time} for workflow {id}.
        slots:
          session_time: query.session_time
          id: path.id
      - text: Truncate {session_time} for workflow {id} using mode {mode}.
        slots:
          session_time: query.session_time
          id: path.id
          mode: query.mode
      method: generated
      generated: '2026-09-26'