# 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 Jobs API
  version: 1.0.0
extends: openapi/treasure-data-jobs-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: 12
- target: $.paths['/job/issue/presto/{database_name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a Presto SQL query on a database
      effect: write
      questions:
      - How do I run a Presto SQL query against a Treasure Data database?
      - Can I set a priority when submitting a Presto query?
      instructions:
      - text: Run Presto query {query} on database {database_name}.
        slots:
          query: requestBody.query
          database_name: path.database_name
      - text: Submit Presto SQL {query} to {database_name} with priority {priority}.
        slots:
          query: requestBody.query
          database_name: path.database_name
          priority: requestBody.priority
      method: generated
      generated: '2026-09-26'
- target: $.paths['/job/issue/hive/{database_name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a Hive query on a database
      effect: write
      questions:
      - How can I submit a Hive query instead of Presto?
      - Can a Hive query job write its output to a result destination?
      instructions:
      - text: Run Hive query {query} on database {database_name}.
        slots:
          query: requestBody.query
          database_name: path.database_name
      - text: Submit Hive query {query} to {database_name} and send output to {result}.
        slots:
          query: requestBody.query
          database_name: path.database_name
          result: requestBody.result
      method: generated
      generated: '2026-09-26'
- target: $.paths['/job/result/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the results of a finished query job
      effect: read
      questions:
      - How do I get the output rows of a query job once it's done?
      - What formats can I download job results in?
      instructions:
      - text: Get the results of job {job_id}.
        slots:
          job_id: path.job_id
      - text: Download results of job {job_id} as {format}.
        slots:
          job_id: path.job_id
          format: query.format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/job/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List query jobs in the account
      effect: read
      questions:
      - What jobs have been run in my account recently?
      - Where can I see a list of all my query jobs?
      instructions:
      - text: List my jobs.
      - text: Show every query job in the account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/job/show/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a job
      effect: read
      questions:
      - How do I see the full details of a specific job, like its query and database?
      - Can I look up a job by its ID to see what it ran?
      instructions:
      - text: Show job {job_id}.
        slots:
          job_id: path.job_id
      - text: Get the query and database used by job {job_id}.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/job/status/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a job's status by ID
      effect: read
      questions:
      - Is my query job still running or has it finished?
      - What was the status of a job's last execution?
      instructions:
      - text: Check the status of job {job_id}.
        slots:
          job_id: path.job_id
      - text: Tell me whether job {job_id} is still running.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/job/status_by_domain_key/{domain_key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a job's status by domain key
      effect: read
      questions:
      - Can I find a job's status using the domain key I assigned instead of its job ID?
      - What's the status of the job I submitted with a particular domain key?
      instructions:
      - text: Check job status for domain key {domain_key}.
        slots:
          domain_key: path.domain_key
      - text: Find out if the job with domain key {domain_key} has finished.
        slots:
          domain_key: path.domain_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/job/statistics/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a job's statistics
      effect: read
      questions:
      - How many records did a job insert?
      - Where can I see execution statistics for a finished job?
      instructions:
      - text: Show statistics for job {job_id}.
        slots:
          job_id: path.job_id
      - text: Tell me how many records job {job_id} inserted.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/job/issue/{job_type}/{database_name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue a job of any type on a database
      effect: write
      questions:
      - Can I issue a job where I choose the job type in the path?
      - Is there a way to set a retry limit and resource pool on a new job?
      instructions:
      - text: Create a {job_type} job on database {database_name} running {query}.
        slots:
          job_type: path.job_type
          database_name: path.database_name
          query: requestBody.query
      - text: Issue a {job_type} job on {database_name} in pool {pool_name} with retry limit {retry_limit}.
        slots:
          job_type: path.job_type
          database_name: path.database_name
          pool_name: requestBody.pool_name
          retry_limit: requestBody.retry_limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/job/kill/{job_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Kill a running job
      effect: destructive
      questions:
      - How do I stop a query that's taking too long?
      - Can I cancel a job that's already running?
      instructions:
      - text: Kill job {job_id}.
        slots:
          job_id: path.job_id
      - text: Stop running job {job_id} immediately.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/job/result_export/{job_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Export a finished job's results to a destination
      effect: write
      questions:
      - How do I send the results of a job I already ran to a connection or table?
      - Can I export an existing job's output into another database table?
      instructions:
      - text: Export results of job {job_id} using connection {result_connection_id}.
        slots:
          job_id: path.job_id
          result_connection_id: requestBody.result_connection_id
      - text: Write results of job {job_id} into table {table} of database {database}.
        slots:
          job_id: path.job_id
          table: requestBody.table
          database: requestBody.database
      method: generated
      generated: '2026-09-26'
- target: $.paths['/export/run/{database_name}/{table_name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Export a table to cloud storage
      effect: write
      questions:
      - How do I dump a whole table out to an S3 bucket?
      - Can a table export be limited to a time range and file format?
      instructions:
      - text: Export table {table_name} in {database_name} to bucket {bucket}.
        slots:
          table_name: path.table_name
          database_name: path.database_name
          bucket: requestBody.bucket
      - text: Export {database_name}.{table_name} as {file_format} from {from} to {to}.
        slots:
          database_name: path.database_name
          table_name: path.table_name
          file_format: requestBody.file_format
          from: requestBody.from
          to: requestBody.to
      method: generated
      generated: '2026-09-26'