Treasure Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Treasure Workflow Attempt API

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

$.info

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

$.paths['/api/attempts'].put

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

$.paths['/api/attempts/{id}/kill'].post

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

$.paths['/api/attempts/{id}/tasks'].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 Attempt API
  version: 1.0.0
extends: openapi/treasure-data-attempt-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: 6
- target: $.paths['/api/attempts'].get
  update:
    x-apievangelist-phrasing:
      intent: List workflow attempts
      effect: read
      questions:
      - Which workflow attempts have run recently in a given project?
      - Can I include retried attempts when listing a workflow's runs?
      instructions:
      - text: List attempts for workflow {workflow} in project {project}.
        slots:
          workflow: query.workflow
          project: query.project
      - text: Show the latest {page_size} workflow attempts.
        slots:
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/attempts'].put
  update:
    x-apievangelist-phrasing:
      intent: Start or resume a workflow run
      effect: write
      questions:
      - How do I trigger a Treasure Data workflow to run right now?
      - Can I resume a failed attempt from the tasks that failed instead of starting over?
      - Will a new run queue up if the maximum number of attempts is already running?
      instructions:
      - text: Start workflow {workflowName} in project {projectName} for session time {sessionTime} with params {params}.
        slots:
          workflowName: requestBody.workflowName
          projectName: requestBody.projectName
          sessionTime: requestBody.sessionTime
          params: requestBody.params
      - text: Run workflow {workflowId} at session time {sessionTime} using params {params}.
        slots:
          workflowId: requestBody.workflowId
          sessionTime: requestBody.sessionTime
          params: requestBody.params
      - text: Resume the failed attempt with {resume} as retry {retryAttemptName}, session time {sessionTime}, params {params}.
        slots:
          resume: requestBody.resume
          retryAttemptName: requestBody.retryAttemptName
          sessionTime: requestBody.sessionTime
          params: requestBody.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/attempts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workflow attempt
      effect: read
      questions:
      - What is the status of a particular workflow attempt?
      - Did a specific attempt finish successfully?
      instructions:
      - text: Show attempt {id}.
        slots:
          id: path.id
      - text: Check the status of workflow attempt {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/attempts/{id}/kill'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running workflow attempt
      effect: destructive
      questions:
      - How do I stop a workflow attempt that is still running?
      - Can I request cancellation of a stuck attempt?
      instructions:
      - text: Kill attempt {id}.
        slots:
          id: path.id
      - text: Request cancellation of running attempt {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/attempts/{id}/retries'].get
  update:
    x-apievangelist-phrasing:
      intent: List all attempts in the same session
      effect: read
      questions:
      - What retries were made in the same session as a given attempt?
      - Can I see every earlier and later try of the session an attempt belongs to?
      instructions:
      - text: List the retries of attempt {id}.
        slots:
          id: path.id
      - text: Show all attempts from the same session as attempt {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/attempts/{id}/tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List the tasks of a workflow attempt
      effect: read
      questions:
      - Which task in a workflow attempt failed?
      - Can I see the individual task states inside one attempt?
      instructions:
      - text: List the tasks of attempt {id}.
        slots:
          id: path.id
      - text: Show which tasks in attempt {id} succeeded or failed.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'