Dremio | Intelligent Lakehouse Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Dremio Intelligent Lakehouse REST Jobs API

5 actions 5 updates phrasing extends openapi/dremio-intelligent-lakehouse-platform-jobs-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Dremio | Intelligent Lakehouse Platform's API. It is a proposal applied on top of the contract, not a document Dremio | Intelligent Lakehouse Platform publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/job'].post

$.paths['/job/{id}'].get

$.paths['/job/{id}/results'].get

$.paths['/job/{id}/cancel'].post

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 Dremio Intelligent Lakehouse REST Jobs API
  version: 1.0.0
extends: openapi/dremio-intelligent-lakehouse-platform-jobs-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: 4
- target: $.paths['/job'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a SQL query as a job
      effect: write
      questions:
      - How do I run a SQL query against my lakehouse through the API?
      - Can I set the schema context a submitted SQL query runs in?
      instructions:
      - text: 'Run this SQL query: {sql}'
        slots:
          sql: requestBody.sql
      - text: Submit the query {sql} with context {context}.
        slots:
          sql: requestBody.sql
          context: requestBody.context
      method: generated
      generated: '2026-10-01'
- target: $.paths['/job/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a query job's status
      effect: read
      questions:
      - Has my SQL query job finished running yet?
      - What state is a submitted job in right now?
      instructions:
      - text: Check the status of job {id}.
        slots:
          id: path.id
      - text: Tell me whether job {id} has completed or failed.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/job/{id}/results'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch the results of a finished job
      effect: read
      questions:
      - Where do I get the rows my completed query returned?
      - Can I download the output of a SQL job once it's done?
      instructions:
      - text: Fetch the results of job {id}.
        slots:
          id: path.id
      - text: Show me the rows returned by completed job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/job/{id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running query job
      effect: destructive
      questions:
      - How do I stop a SQL query that's taking too long?
      - Can I cancel a job that is still running?
      instructions:
      - text: Cancel job {id}.
        slots:
          id: path.id
      - text: Stop the running query with job ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'