Dremio | Intelligent Lakehouse Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Dremio Intelligent Lakehouse REST Catalog API

5 actions 5 updates phrasing extends openapi/dremio-intelligent-lakehouse-platform-catalog-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['/catalog'].get

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

$.paths['/catalog/{id}'].delete

$.paths['/catalog/by-path/{path}'].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 Dremio Intelligent Lakehouse REST Catalog API
  version: 1.0.0
extends: openapi/dremio-intelligent-lakehouse-platform-catalog-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['/catalog'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse the top-level catalog
      effect: read
      questions:
      - What spaces, sources and home folders are at the top level of my catalog?
      - Can I see everything at the root of the catalog in one call?
      - Which extra details can I include when listing the root catalog?
      instructions:
      - text: Show me the top-level catalog of this instance.
      - text: List the root catalog and include {include}.
        slots:
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/catalog/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a catalog item by its ID
      effect: read
      questions:
      - How do I fetch the details of a dataset or folder when I only have its ID?
      - What does the catalog store about an entity, given its ID?
      instructions:
      - text: Get catalog entity {id}.
        slots:
          id: path.id
      - text: Show me the details of the catalog object with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/catalog/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a catalog item
      effect: destructive
      questions:
      - How do I remove a dataset, folder or space from the catalog?
      - Is deleting a catalog entity by ID permanent?
      instructions:
      - text: Delete catalog entity {id}.
        slots:
          id: path.id
      - text: Remove the catalog object with ID {id} from the lakehouse.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/catalog/by-path/{path}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a catalog item by its path
      effect: read
      questions:
      - How do I find a dataset by its dotted path instead of its ID?
      - Can I look up a folder or table using its full catalog path?
      instructions:
      - text: Get the catalog entity at path {path}.
        slots:
          path: path.path
      - text: Find the dataset located at {path} in the catalog and show its ID.
        slots:
          path: path.path
      method: generated
      generated: '2026-10-01'