Cloudera · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloudera Lakehouse Optimizer Service Lakehouseopt API

31 actions 31 updates phrasing extends openapi/cloudera-lakehouseopt-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Cloudera's API. It is a proposal applied on top of the contract, not a document Cloudera publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 31 · first 16 shown; the file carries all of them

$.info
$.paths['/api/v1/lakehouseopt/getHealth'].post
$.paths['/api/v1/lakehouseopt/listEnvironments'].post
$.paths['/api/v1/lakehouseopt/getDatahubCrn'].post
$.paths['/api/v1/lakehouseopt/getCloDatahub'].post
$.paths['/api/v1/lakehouseopt/listPolicies'].post
$.paths['/api/v1/lakehouseopt/getPolicy'].post
$.paths['/api/v1/lakehouseopt/downloadPolicy'].post
$.paths['/api/v1/lakehouseopt/getNamespaces'].post
$.paths['/api/v1/lakehouseopt/getTableNames'].post
$.paths['/api/v1/lakehouseopt/listTables'].post
$.paths['/api/v1/lakehouseopt/getTablePolicies'].post
$.paths['/api/v1/lakehouseopt/getPolicyNames'].post
$.paths['/api/v1/lakehouseopt/createTablePoliciesAssociations'].post
$.paths['/api/v1/lakehouseopt/getScripts'].post
$.paths['/api/v1/lakehouseopt/getAssociations'].post

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 Cloudera Lakehouse Optimizer Service Lakehouseopt API
  version: 1.0.0
extends: openapi/cloudera-lakehouseopt-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: 30
- target: $.paths['/api/v1/lakehouseopt/getHealth'].post
  update:
    x-apievangelist-phrasing:
      intent: Check health of Lakehouse Optimizer components
      effect: read
      questions:
      - Are the Lakehouse Optimizer scheduler, dispatcher and DAO services healthy?
      - Can I limit a CLO health check to a specific scope?
      instructions:
      - text: Run a health check on the Lakehouse Optimizer for Data Hub {datahubCrn}.
        slots:
          datahubCrn: requestBody.datahubCrn
      - text: Check CLO component health for {datahubCrn} with scope {scope}.
        slots:
          datahubCrn: requestBody.datahubCrn
          scope: requestBody.scope
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/listEnvironments'].post
  update:
    x-apievangelist-phrasing:
      intent: List environments with their CLO Data Hub
      effect: read
      questions:
      - Which of my environments have a Lakehouse Optimizer Data Hub enabled?
      - Can I page through the environments known to Lakehouse Optimizer?
      instructions:
      - text: List my environments along with their Lakehouse Optimizer Data Hub details.
      - text: List Lakehouse Optimizer environments, {pageSize} per page.
        slots:
          pageSize: requestBody.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/getDatahubCrn'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up the Data Hub CRN for an environment
      effect: read
      questions:
      - What is the Data Hub CRN I should use for Lakehouse Optimizer calls in my environment?
      - Can I resolve an environment CRN to its Data Hub CRN?
      instructions:
      - text: Get the Data Hub CRN for environment {environmentCrn}.
        slots:
          environmentCrn: requestBody.environmentCrn
      - text: Resolve environment {environmentCrn} to its Data Hub CRN only.
        slots:
          environmentCrn: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/getCloDatahub'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the CLO Data Hub for an environment
      effect: read
      questions:
      - Which Data Hub runs Lakehouse Optimizer in a given environment, and what are its details?
      - Can I fetch the full CLO Data Hub record for one environment?
      instructions:
      - text: Fetch the Lakehouse Optimizer Data Hub record for environment {environmentCrn}.
        slots:
          environmentCrn: requestBody.environmentCrn
      - text: Show the CLO Data Hub details in environment {environmentCrn}.
        slots:
          environmentCrn: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/listPolicies'].post
  update:
    x-apievangelist-phrasing:
      intent: List table maintenance policies
      effect: read
      questions:
      - What maintenance policies are defined in Lakehouse Optimizer?
      - Can I list only the policies that apply to one namespace?
      instructions:
      - text: List all Lakehouse Optimizer policies on Data Hub {datahubCrn}.
        slots:
          datahubCrn: requestBody.datahubCrn
      - text: List the policies with full details in namespace {namespace} on {datahubCrn}.
        slots:
          namespace: requestBody.namespace
          datahubCrn: requestBody.datahubCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/getPolicy'].post
  update:
    x-apievangelist-phrasing:
      intent: Get details of a maintenance policy
      effect: read
      questions:
      - What actions, scope, versions and status does a particular policy have?
      - Can I see which tables a single named policy is associated with?
      instructions:
      - text: Get the details of policy {policyName} on Data Hub {datahubCrn}.
        slots:
          policyName: requestBody.policyName
          datahubCrn: requestBody.datahubCrn
      - text: Show version IDs and actions for policy {policyName} on {datahubCrn}.
        slots:
          policyName: requestBody.policyName
          datahubCrn: requestBody.datahubCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/downloadPolicy'].post
  update:
    x-apievangelist-phrasing:
      intent: Download a policy version's definition
      effect: read
      questions:
      - How do I get the scripts and arguments behind a specific policy version?
      - Can I export the definition of an older version of a policy?
      instructions:
      - text: Download version {policyVersion} of policy {policyName} from {datahubCrn}.
        slots:
          policyVersion: requestBody.policyVersion
          policyName: requestBody.policyName
          datahubCrn: requestBody.datahubCrn
      - text: Export the scripts for policy {policyName} version {policyVersion} on Data Hub {datahubCrn}.
        slots:
          policyName: requestBody.policyName
          policyVersion: requestBody.policyVersion
          datahubCrn: requestBody.datahubCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/getNamespaces'].post
  update:
    x-apievangelist-phrasing:
      intent: List namespaces in the catalog
      effect: read
      questions:
      - Which namespaces exist in the catalog Lakehouse Optimizer manages?
      - What databases can I target with optimization policies?
      instructions:
      - text: List all namespaces in the catalog for Data Hub {datahubCrn}.
        slots:
          datahubCrn: requestBody.datahubCrn
      - text: Show me every namespace Lakehouse Optimizer sees on {datahubCrn}.
        slots:
          datahubCrn: requestBody.datahubCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/getTableNames'].post
  update:
    x-apievangelist-phrasing:
      intent: Get just the table names in a namespace
      effect: read
      questions:
      - What are the names of the tables in a given namespace?
      - Can I get a plain list of table names without the extra table details?
      instructions:
      - text: Get the table names in namespace {namespace} on Data Hub {datahubCrn}.
        slots:
          namespace: requestBody.namespace
          datahubCrn: requestBody.datahubCrn
      - text: Give me only the names of tables in {namespace} on {datahubCrn}.
        slots:
          namespace: requestBody.namespace
          datahubCrn: requestBody.datahubCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/listTables'].post
  update:
    x-apievangelist-phrasing:
      intent: List tables in a namespace with details
      effect: read
      questions:
      - Which tables in a namespace does Lakehouse Optimizer track, with their details?
      - Can I list the table records in one namespace?
      instructions:
      - text: List the tables with their details in namespace {namespace} on {datahubCrn}.
        slots:
          namespace: requestBody.namespace
          datahubCrn: requestBody.datahubCrn
      - text: Show the table entries for namespace {namespace} on Data Hub {datahubCrn}.
        slots:
          namespace: requestBody.namespace
          datahubCrn: requestBody.datahubCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/getTablePolicies'].post
  update:
    x-apievangelist-phrasing:
      intent: Get policies applied to a table
      effect: read
      questions:
      - Which maintenance policies are applied to a particular table?
      - Can I check what policies run against one table in a namespace?
      instructions:
      - text: Get the policies on table {tableName} in namespace {namespace} on {datahubCrn}.
        slots:
          tableName: requestBody.tableName
          namespace: requestBody.namespace
          datahubCrn: requestBody.datahubCrn
      - text: Show which policies cover table {namespace}.{tableName} on Data Hub {datahubCrn}.
        slots:
          namespace: requestBody.namespace
          tableName: requestBody.tableName
          datahubCrn: requestBody.datahubCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/getPolicyNames'].post
  update:
    x-apievangelist-phrasing:
      intent: Get policy names linked to a namespace
      effect: read
      questions:
      - What policy names are associated with a namespace?
      - Can I get just the names of policies tied to one database?
      instructions:
      - text: Get the policy names associated with namespace {namespace} on {datahubCrn}.
        slots:
          namespace: requestBody.namespace
          datahubCrn: requestBody.datahubCrn
      - text: List only the names of policies linked to {namespace} on Data Hub {datahubCrn}.
        slots:
          namespace: requestBody.namespace
          datahubCrn: requestBody.datahubCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/createTablePoliciesAssociations'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach policies to a table
      effect: write
      questions:
      - How do I attach several maintenance policies to one table at once?
      - Can I associate a table with a list of policies?
      instructions:
      - text: Associate table {tableName} in {namespace} on {datahubCrn} with policies {policies}.
        slots:
          tableName: requestBody.tableName
          namespace: requestBody.namespace
          datahubCrn: requestBody.datahubCrn
          policies: requestBody.policies
      - text: Attach policies {policies} to table {namespace}.{tableName} on Data Hub {datahubCrn}.
        slots:
          policies: requestBody.policies
          namespace: requestBody.namespace
          tableName: requestBody.tableName
          datahubCrn: requestBody.datahubCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/getScripts'].post
  update:
    x-apievangelist-phrasing:
      intent: List default and catalog-level scripts
      effect: read
      questions:
      - Which maintenance scripts are available to build policies from?
      - What default or catalog-defined scripts does Lakehouse Optimizer provide?
      instructions:
      - text: Get the available policy scripts on Data Hub {datahubCrn}.
        slots:
          datahubCrn: requestBody.datahubCrn
      - text: List the default and catalog-level scripts for {datahubCrn}.
        slots:
          datahubCrn: requestBody.datahubCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/getAssociations'].post
  update:
    x-apievangelist-phrasing:
      intent: Get tables associated with a policy
      effect: read
      questions:
      - Which tables, grouped by namespace, is a policy currently associated with?
      - Can I see the current table associations for a single policy?
      instructions:
      - text: Get the table associations for policy {policyName} on {datahubCrn}.
        slots:
          policyName: requestBody.policyName
          datahubCrn: requestBody.datahubCrn
      - text: Show the tables per namespace currently bound to policy {policyName} on Data Hub {datahubCrn}.
        slots:
          policyName: requestBody.policyName
          datahubCrn: requestBody.datahubCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/createAssociations'].post
  update:
    x-apievangelist-phrasing:
      intent: Associate tables with a policy
      effect: write
      questions:
      - How do I apply one policy to a set of tables across namespaces?
      - Can I bind many tables to a single policy in one call?
      instructions:
      - text: Associate policy {policyName} with tables {associations} on {datahubCrn}.
        slots:
          policyName: requestBody.policyName
          associations: requestBody.associations
          datahubCrn: requestBody.datahubCrn
      - text: Bind the table set {associations} to policy {policyName} on Data Hub {datahubCrn}.
        slots:
          associations: requestBody.associations
          policyName: requestBody.policyName
          datahubCrn: requestBody.datahubCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/createPolicy'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a table maintenance policy
      effect: write
      questions:
      - How do I define a new optimization policy in Lakehouse Optimizer?
      - What resources do I need to supply when creating a policy?
      instructions:
      - text: Create policy {policyName} with resources {resources} on Data Hub {datahubCrn}.
        slots:
          policyName: requestBody.policyName
          resources: requestBody.resources
          datahubCrn: requestBody.datahubCrn
      - text: Define a new Lakehouse Optimizer policy named {policyName} on {datahubCrn} using {resources}.
        slots:
          policyName: requestBody.policyName
          datahubCrn: requestBody.datahubCrn
          resources: requestBody.resources
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/updatePolicy'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an existing maintenance policy
      effect: write
      questions:
      - Can I change the resources of a policy that already exists?
      - What do I send to modify an existing optimization policy?
      instructions:
      - text: Update existing policy {policyName} on {datahubCrn} with resources {resources}.
        slots:
          policyName: requestBody.policyName
          datahubCrn: requestBody.datahubCrn
          resources: requestBody.resources
      - text: Replace the resources of policy {policyName} on Data Hub {datahubCrn} with {resources}.
        slots:
          policyName: requestBody.policyName
          datahubCrn: requestBody.datahubCrn
          resources: requestBody.resources
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/unsubscribePolicy'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove a policy from a table
      effect: destructive
      questions:
      - How do I stop a single policy from applying to one table?
      - Can I unsubscribe one table from a policy without deleting the policy?
      instructions:
      - text: Unsubscribe policy {policyName} from table {tableName} in {namespace} on {datahubCrn}.
        slots:
          policyName: requestBody.policyName
          tableName: requestBody.tableName
          namespace: requestBody.namespace
          datahubCrn: requestBody.datahubCrn
      - text: Detach policy {policyName} from {namespace}.{tableName} on Data Hub {datahubCrn}.
        slots:
          policyName: requestBody.policyName
          namespace: requestBody.namespace
          tableName: requestBody.tableName
          datahubCrn: requestBody.datahubCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/pauseTable'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause maintenance on a table
      effect: write
      questions:
      - Can I temporarily stop all maintenance actions on a table?
      - How do I put optimization of one table on hold?
      instructions:
      - text: Pause maintenance on table {tableName} in {namespace} on {datahubCrn}.
        slots:
          tableName: requestBody.tableName
          namespace: requestBody.namespace
          datahubCrn: requestBody.datahubCrn
      - text: Put all maintenance actions for {namespace}.{tableName} on hold on Data Hub {datahubCrn}.
        slots:
          namespace: requestBody.namespace
          tableName: requestBody.tableName
          datahubCrn: requestBody.datahubCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/unpauseTable'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume maintenance on a paused table
      effect: write
      questions:
      - How do I restart maintenance on a table I paused earlier?
      - Can I unpause a table so its policies run again?
      instructions:
      - text: Unpause table {tableName} in {namespace} on {datahubCrn}.
        slots:
          tableName: requestBody.tableName
          namespace: requestBody.namespace
          datahubCrn: requestBody.datahubCrn
      - text: Resume maintenance actions on paused table {namespace}.{tableName} on Data Hub {datahubCrn}.
        slots:
          namespace: requestBody.namespace
          tableName: requestBody.tableName
          datahubCrn: requestBody.datahubCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/listTasks'].post
  update:
    x-apievangelist-phrasing:
      intent: List maintenance tasks in a namespace
      effect: read
      questions:
      - What maintenance tasks has Lakehouse Optimizer run in a namespace?
      - Can I page through CLO tasks for one namespace?
      instructions:
      - text: List maintenance tasks for namespace {namespace} on {datahubCrn}.
        slots:
          namespace: requestBody.namespace
          datahubCrn: requestBody.datahubCrn
      - text: Show {pageSize} CLO maintenance tasks at a time for {namespace} on Data Hub {datahubCrn}.
        slots:
          pageSize: requestBody.pageSize
          namespace: requestBody.namespace
          datahubCrn: requestBody.datahubCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/changeTablePolicy'].post
  update:
    x-apievangelist-phrasing:
      intent: Add, remove or replace policies on a table
      effect: write
      questions:
      - Can I swap the policies on a table for a different set?
      - Which operations can I perform to change a table's policies?
      instructions:
      - text: Run the {operation} policy change with {policies} on table {tableName} in {namespace} on {datahubCrn}.
        slots:
          operation: requestBody.operation
          policies: requestBody.policies
          tableName: requestBody.tableName
          namespace: requestBody.namespace
          datahubCrn: requestBody.datahubCrn
      - text: Replace the policies on {namespace}.{tableName} with {policies} using operation {operation} on Data Hub {datahubCrn}.
        slots:
          namespace: requestBody.namespace
          tableName: requestBody.tableName
          policies: requestBody.policies
          operation: requestBody.operation
          datahubCrn: requestBody.datahubCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/deletePolicy'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a policy definition for a resource
      effect: destructive
      questions:
      - How do I delete a policy definition for a namespace or table?
      - What happens if I use a wildcard namespace when deleting a policy?
      instructions:
      - text: Delete policy {policyName} for resource scope {resourceScope} on {datahubCrn}.
        slots:
          policyName: requestBody.policyName
          resourceScope: requestBody.resourceScope
          datahubCrn: requestBody.datahubCrn
      - text: Remove the definition of policy {policyName} on Data Hub {datahubCrn} for {resourceScope}.
        slots:
          policyName: requestBody.policyName
          datahubCrn: requestBody.datahubCrn
          resourceScope: requestBody.resourceScope
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/getTimezones'].post
  update:
    x-apievangelist-phrasing:
      intent: List supported policy schedule timezones
      effect: read
      questions:
      - Which timezones can I use when scheduling a policy?
      - What timezone values does Lakehouse Optimizer accept for schedules?
      instructions:
      - text: List the supported timezones for policy schedules.
      - text: Show every timezone I can schedule a Lakehouse Optimizer policy in.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/getAssociatedTables'].post
  update:
    x-apievangelist-phrasing:
      intent: Show all tables flagged by policy association
      effect: read
      questions:
      - For a policy, which tables are associated and which are not?
      - Can I see every table with a flag showing whether a policy covers it?
      instructions:
      - text: Show all tables with an association flag for policy {policyName} on {datahubCrn}.
        slots:
          policyName: requestBody.policyName
          datahubCrn: requestBody.datahubCrn
      - text: List every table and whether policy {policyName} applies to it on Data Hub {datahubCrn}.
        slots:
          policyName: requestBody.policyName
          datahubCrn: requestBody.datahubCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/getAssociatedNamespaces'].post
  update:
    x-apievangelist-phrasing:
      intent: Show namespaces flagged by policy association
      effect: read
      questions:
      - Which namespaces is a policy associated with, and which are left out?
      - Can I get all namespaces with a flag for a given policy?
      instructions:
      - text: Show all namespaces with an association flag for policy {policyName} on {datahubCrn}.
        slots:
          policyName: requestBody.policyName
          datahubCrn: requestBody.datahubCrn
      - text: List each namespace and whether it is tied to policy {policyName} on Data Hub {datahubCrn}.
        slots:
          policyName: requestBody.policyName
          datahubCrn: requestBody.datahubCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/getTableStatusDetails'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a table's current policy status details
      effect: read
      questions:
      - Why is a table showing a particular status for one of its policies?
      - Can I drill into the current status of a table under a given policy?
      instructions:
      - text: Get status {status} details for table {tableName} in {namespace} under policy {policyName} on {datahubCrn}.
        slots:
          status: requestBody.status
          tableName: requestBody.tableName
          namespace: requestBody.namespace
          policyName: requestBody.policyName
          datahubCrn: requestBody.datahubCrn
      - text: Explain the {status} status of {namespace}.{tableName} for policy {policyName} on Data Hub {datahubCrn}.
        slots:
          status: requestBody.status
          namespace: requestBody.namespace
          tableName: requestBody.tableName
          policyName: requestBody.policyName
          datahubCrn: requestBody.datahubCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/executePolicy'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a policy on a table now
      effect: write
      questions:
      - Can I trigger a maintenance policy on a table right away instead of waiting for its schedule?
      - Is there a dry-run mode to evaluate a policy without changing the table?
      instructions:
      - text: Execute policy {policyName} on table {tableName} in {namespace} on {datahubCrn}.
        slots:
          policyName: requestBody.policyName
          tableName: requestBody.tableName
          namespace: requestBody.namespace
          datahubCrn: requestBody.datahubCrn
      - text: Dry-run policy {policyName} against {namespace}.{tableName} on Data Hub {datahubCrn} without changing anything.
        slots:
          policyName: requestBody.policyName
          namespace: requestBody.namespace
          tableName: requestBody.tableName
          datahubCrn: requestBody.datahubCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/lakehouseopt/getAssociationDetails'].post
  update:
    x-apievangelist-phrasing:
      intent: Get direct and wildcard policy association details
      effect: read
      questions:
      - Which policies are associated directly versus through a wildcard association?
      - Can I get an overview of all policy associations on my Data Hub?
      instructions:
      - text: Get the direct and star policy association details for Data Hub {datahubCrn}.
        slots:
          datahubCrn: requestBody.datahubCrn
      - text: Summarize every policy association on {datahubCrn}.
        slots:
          datahubCrn: requestBody.datahubCrn
      method: generated
      generated: '2026-10-01'