Treasure Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Treasure Workflow Log API

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

$.info
$.paths['/api/logs/{attempt_id}/files'].get
$.paths['/api/logs/{attempt_id}/files/{file_name}'].get

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 Workflow Log API
  version: 1.0.0
extends: openapi/treasure-data-log-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: 2
- target: $.paths['/api/logs/{attempt_id}/files'].get
  update:
    x-apievangelist-phrasing:
      intent: List the log files of a workflow attempt
      effect: read
      questions:
      - Which log files were produced by a workflow attempt?
      - Can I list only the logs for one task in an attempt?
      instructions:
      - text: List the log files for attempt {attempt_id}.
        slots:
          attempt_id: path.attempt_id
      - text: Show log files of attempt {attempt_id} for task {task}.
        slots:
          attempt_id: path.attempt_id
          task: query.task
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/logs/{attempt_id}/files/{file_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a workflow log file
      effect: read
      questions:
      - How do I download a specific log file to see why a task failed?
      - Can I fetch the contents of one log file from an attempt?
      instructions:
      - text: Download log file {file_name} from attempt {attempt_id}.
        slots:
          file_name: path.file_name
          attempt_id: path.attempt_id
      - text: Fetch the contents of {file_name} for workflow attempt {attempt_id}.
        slots:
          file_name: path.file_name
          attempt_id: path.attempt_id
      method: generated
      generated: '2026-09-26'