Treasure Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Treasure Data Project API

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

$.info
$.paths['/api/projects'].get
$.paths['/api/projects'].put
$.paths['/api/projects'].post
$.paths['/api/projects/{id}'].get
$.paths['/api/projects/{id}'].delete
$.paths['/api/projects/{id}'].patch
$.paths['/api/projects/{id}/archive'].get
$.paths['/api/projects/{id}/revisions'].get
$.paths['/api/projects/{id}/schedules'].get
$.paths['/api/projects/{id}/secrets'].get
$.paths['/api/projects/{id}/secrets/{key}'].put
$.paths['/api/projects/{id}/secrets/{key}'].delete
$.paths['/api/projects/{id}/sessions'].get
$.paths['/api/projects/{id}/workflows'].get
$.paths['/api/projects/{id}/workflows/{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 Data Project API
  version: 1.0.0
extends: openapi/treasure-data-project-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: 15
- target: $.paths['/api/projects'].get
  update:
    x-apievangelist-phrasing:
      intent: List LLM projects
      effect: read
      questions:
      - Which LLM projects exist in my account?
      - Can I search projects by text or show only managed ones?
      instructions:
      - text: List my LLM projects.
      - text: Search LLM projects for {fulltext}, sorted by {sort}.
        slots:
          fulltext: query.filter[fulltext]
          sort: query.sort
      - text: 'List projects that have form interfaces: {has_form_interfaces}.'
        slots:
          has_form_interfaces: query.filter[has_form_interfaces]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/projects'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload a workflow project archive
      effect: write
      questions:
      - How do I push a workflow project archive as a new revision?
      - Can I upload a project without starting its schedules?
      instructions:
      - text: Upload project {project} as revision {revision}.
        slots:
          project: query.project
          revision: query.revision
      - text: Upload project {project} revision {revision} and skip schedules with skip_schedule {skip_schedule}.
        slots:
          project: query.project
          revision: query.revision
          skip_schedule: query.skip_schedule
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/projects'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an LLM project
      effect: write
      questions:
      - Can I set up a new project to hold agents and interfaces?
      - What is needed to create an LLM project?
      instructions:
      - text: Create an LLM project with {data}.
        slots:
          data: requestBody.data
      - text: Set up a new LLM project using payload {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/projects/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an LLM project
      effect: read
      questions:
      - What settings and related resources does one LLM project hold?
      - Can I include related resources when fetching an LLM project?
      instructions:
      - text: Show LLM project {id}.
        slots:
          id: path.id
      - text: Get LLM project {id} including {include}.
        slots:
          id: path.id
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/projects/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an LLM project
      effect: destructive
      questions:
      - Can I delete an LLM project I no longer use?
      - What removes an LLM project?
      instructions:
      - text: Delete LLM project {id}.
        slots:
          id: path.id
      - text: Remove the LLM project {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/projects/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an LLM project
      effect: write
      questions:
      - Can I rename or reconfigure an existing LLM project?
      - Which LLM project settings can be changed after creation?
      instructions:
      - text: Update LLM project {id} with {data}.
        slots:
          id: path.id
          data: requestBody.data
      - text: Rename LLM project {id} using payload {data}.
        slots:
          id: path.id
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/projects/{id}/archive'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a project archive
      effect: read
      questions:
      - How do I download the archive of a workflow project revision?
      - Can I get a direct download link for a project archive?
      instructions:
      - text: Download the archive of project {id} at revision {revision}.
        slots:
          id: path.id
          revision: query.revision
      - text: Get a direct download of project {id} revision {revision} with direct_download {direct_download}.
        slots:
          id: path.id
          revision: query.revision
          direct_download: query.direct_download
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/projects/{id}/revisions'].get
  update:
    x-apievangelist-phrasing:
      intent: List revisions of a project
      effect: read
      questions:
      - What revisions has a workflow project gone through?
      - Can I page through a project's revision history?
      instructions:
      - text: List revisions of project {id}.
        slots:
          id: path.id
      - text: Show the revision history of workflow project {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/projects/{id}/schedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's schedules
      effect: read
      questions:
      - Which schedules belong to a workflow project?
      - Can I filter a project's schedules to one workflow?
      instructions:
      - text: List schedules in project {id}.
        slots:
          id: path.id
      - text: List schedules of workflow {workflow} in project {id}.
        slots:
          workflow: query.workflow
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/projects/{id}/secrets'].get
  update:
    x-apievangelist-phrasing:
      intent: List secret keys of a project
      effect: read
      questions:
      - What secret keys are set on a workflow project?
      - Can I see which secrets a project has without their values?
      instructions:
      - text: List the secret keys of project {id}.
        slots:
          id: path.id
      - text: Show which secrets are set on workflow project {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/projects/{id}/secrets/{key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a secret on a project
      effect: write
      questions:
      - How do I store a credential as a secret on a workflow project?
      - Can I update a project secret's value?
      instructions:
      - text: Set secret {key} on project {id} to {value}.
        slots:
          key: path.key
          id: path.id
          value: requestBody.value
      - text: Store {value} as secret {key} in workflow project {id}.
        slots:
          value: requestBody.value
          key: path.key
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/projects/{id}/secrets/{key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a secret from a project
      effect: destructive
      questions:
      - How do I remove a secret from a workflow project?
      - Can I delete a project secret I no longer need?
      instructions:
      - text: Delete secret {key} from project {id}.
        slots:
          key: path.key
          id: path.id
      - text: Remove the {key} secret from workflow project {id}.
        slots:
          key: path.key
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/projects/{id}/sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's workflow sessions
      effect: read
      questions:
      - What sessions have run for a workflow project?
      - Can I list only the sessions of one workflow in a project?
      instructions:
      - text: List sessions of project {id}.
        slots:
          id: path.id
      - text: List sessions of workflow {workflow} in project {id}.
        slots:
          workflow: query.workflow
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/projects/{id}/workflows'].get
  update:
    x-apievangelist-phrasing:
      intent: List workflows in a project revision
      effect: read
      questions:
      - Which workflows are defined in a given revision of a project?
      - Can I list a project's workflows filtered by name?
      instructions:
      - text: List workflows in project {id} at revision {revision}.
        slots:
          id: path.id
          revision: query.revision
      - text: List workflows named {name} in project {id} revision {revision}.
        slots:
          name: query.name
          id: path.id
          revision: query.revision
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/projects/{id}/workflows/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project's workflow by name
      effect: read
      questions:
      - How do I look up a workflow in a project by its name?
      - Can I read a named workflow's definition from a specific project revision?
      instructions:
      - text: Get workflow {name} in project {id}.
        slots:
          name: path.name
          id: path.id
      - text: Get workflow {name} from project {id} at revision {revision}.
        slots:
          name: path.name
          id: path.id
          revision: query.revision
      method: generated
      generated: '2026-09-26'