Treasure Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Treasure Workflow Session API

4 actions 4 updates phrasing extends openapi/treasure-data-session-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/sessions'].get

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

$.paths['/api/sessions/{id}/attempts'].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 Session API
  version: 1.0.0
extends: openapi/treasure-data-session-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/sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List workflow sessions
      effect: read
      questions:
      - What workflow sessions have run in my account recently?
      - Can I page through workflow sessions a set number at a time?
      instructions:
      - text: List my workflow sessions.
      - text: Show {page_size} workflow sessions after session {last_id}.
        slots:
          page_size: query.page_size
          last_id: query.last_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/sessions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workflow session
      effect: read
      questions:
      - What is the state of a specific workflow session?
      - Can I look up one session's details by its ID?
      instructions:
      - text: Show workflow session {id}.
        slots:
          id: path.id
      - text: Get the details and latest attempt of session {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/sessions/{id}/attempts'].get
  update:
    x-apievangelist-phrasing:
      intent: List the attempts of a workflow session
      effect: read
      questions:
      - How many times was a particular session attempted?
      - Can I see every run attempt that belongs to one session?
      instructions:
      - text: List the attempts of session {id}.
        slots:
          id: path.id
      - text: Show {page_size} attempts for session {id}.
        slots:
          page_size: query.page_size
          id: path.id
      method: generated
      generated: '2026-09-26'