# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cloudera Service Datacatalog API
  version: 1.0.0
extends: openapi/cloudera-data-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: 20
- target: $.paths['/api/v1/datacatalog/launchProfilers'].post
  update:
    x-apievangelist-phrasing:
      intent: Launch data profilers in a data lake
      effect: write
      questions:
      - How do I start the Data Catalog profilers on my data lake?
      - Can I enable high availability and cap the node count for profilers?
      instructions:
      - text: Launch Data Catalog profilers in data lake {datalake}.
        slots:
          datalake: requestBody.datalake
      - text: Launch profilers {profilers} in {datalake} with HA {enableHA} and at most {maxNodes} nodes.
        slots:
          profilers: requestBody.profilers
          datalake: requestBody.datalake
          enableHA: requestBody.enableHA
          maxNodes: requestBody.maxNodes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/datacatalog/getDataShare'].post
  update:
    x-apievangelist-phrasing:
      intent: Get one Data Share's details
      effect: read
      questions:
      - What assets and external users are in a specific Data Share?
      - Can I view the terms and settings of a single Data Share?
      instructions:
      - text: Show Data Share {dataShareId} in data lake {datalakeCrn} and environment {environmentCrn}.
        slots:
          dataShareId: requestBody.dataShareId
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      - text: Get the assets and recipients of Data Share {dataShareId} ({datalakeCrn}, {environmentCrn}).
        slots:
          dataShareId: requestBody.dataShareId
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/datacatalog/listDataShares'].post
  update:
    x-apievangelist-phrasing:
      intent: List Data Shares in a data lake
      effect: read
      questions:
      - Which Data Shares exist in my data lake?
      - Can I filter Data Shares by name?
      instructions:
      - text: List Data Shares in data lake {datalakeCrn} of environment {environmentCrn}.
        slots:
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      - text: Find Data Shares named {name} in {datalakeCrn} ({environmentCrn}).
        slots:
          name: requestBody.name
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/datacatalog/createExternalUsers'].post
  update:
    x-apievangelist-phrasing:
      intent: Register external users for data sharing
      effect: write
      questions:
      - How do I let people outside Cloudera access shared data?
      - Can I create several external data-sharing users at once?
      instructions:
      - text: Create external users {externalUsers} in data lake {datalakeCrn}, environment {environmentCrn}.
        slots:
          externalUsers: requestBody.externalUsers
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      - text: Register outside partners {externalUsers} as data-sharing users for {datalakeCrn} in {environmentCrn}.
        slots:
          externalUsers: requestBody.externalUsers
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/datacatalog/listExternalUsers'].post
  update:
    x-apievangelist-phrasing:
      intent: List external data-sharing users
      effect: read
      questions:
      - Who are the external users registered for data sharing?
      - Can I search external users by a term?
      instructions:
      - text: List external users for data lake {datalakeCrn} in environment {environmentCrn}.
        slots:
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      - text: Search external users for {searchTerm} in {datalakeCrn} ({environmentCrn}).
        slots:
          searchTerm: requestBody.searchTerm
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/datacatalog/regenerateExternalUserCredentials'].post
  update:
    x-apievangelist-phrasing:
      intent: Regenerate an external user's credentials
      effect: destructive
      questions:
      - How do I issue fresh credentials to an external data-sharing user?
      - Do an external user's old credentials stop working when I regenerate them?
      instructions:
      - text: Regenerate credentials for external user {externalUserId} in {datalakeCrn}, environment {environmentCrn}.
        slots:
          externalUserId: requestBody.externalUserId
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      - text: Rotate external user {externalUserId}'s login for data lake {datalakeCrn} ({environmentCrn}).
        slots:
          externalUserId: requestBody.externalUserId
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/datacatalog/deleteExternalUser'].post
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete an external user
      effect: destructive
      questions:
      - How do I permanently remove an outside user from data sharing?
      - Does deleting an external user cut off all their Data Shares?
      instructions:
      - text: Delete external user {externalUserId} from {datalakeCrn} in environment {environmentCrn}.
        slots:
          externalUserId: requestBody.externalUserId
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      - text: Permanently remove external user {externalUserId} ({datalakeCrn}, {environmentCrn}).
        slots:
          externalUserId: requestBody.externalUserId
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/datacatalog/updateDataShare'].post
  update:
    x-apievangelist-phrasing:
      intent: Edit a Data Share's metadata
      effect: write
      questions:
      - Can I change the expiration time or terms of use on an existing Data Share?
      - How do I rename a Data Share or update its keywords?
      instructions:
      - text: Rename Data Share {dataShareId} to {dataShareName} in {datalakeCrn} ({environmentCrn}).
        slots:
          dataShareId: requestBody.dataShareId
          dataShareName: requestBody.dataShareName
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      - text: Set Data Share {dataShareId} to expire at {expiryTime} ({datalakeCrn}, {environmentCrn}).
        slots:
          dataShareId: requestBody.dataShareId
          expiryTime: requestBody.expiryTime
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/datacatalog/revokeExternalUserCredentials'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke an external user's credentials
      effect: destructive
      questions:
      - How do I immediately cut off an external user's access to shared data?
      - Is revoking credentials different from deleting the external user?
      instructions:
      - text: Revoke credentials for external user {externalUserId} in {datalakeCrn}, environment {environmentCrn}.
        slots:
          externalUserId: requestBody.externalUserId
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      - text: Cut off external user {externalUserId}'s access right now ({datalakeCrn}, {environmentCrn}).
        slots:
          externalUserId: requestBody.externalUserId
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/datacatalog/createDataShare'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Data Share
      effect: write
      questions:
      - How do I share tables with people inside or outside Cloudera?
      - Can I attach terms of use and an expiry when I create a Data Share?
      instructions:
      - text: Create Data Share {dataShareName} with assets {assets} in {datalakeCrn} ({environmentCrn}).
        slots:
          dataShareName: requestBody.dataShareName
          assets: requestBody.assets
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      - text: Create share {dataShareName} of {assets} for external users {externalUsers} in {datalakeCrn}, environment {environmentCrn}.
        slots:
          dataShareName: requestBody.dataShareName
          assets: requestBody.assets
          externalUsers: requestBody.externalUsers
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/datacatalog/deleteDataShare'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a Data Share
      effect: destructive
      questions:
      - How do I permanently delete a Data Share?
      - Must a Data Share be unshared before I can delete it?
      instructions:
      - text: Delete Data Share {dataShareId} from {datalakeCrn} in environment {environmentCrn}.
        slots:
          dataShareId: requestBody.dataShareId
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      - text: Permanently remove share {dataShareId} ({datalakeCrn}, {environmentCrn}).
        slots:
          dataShareId: requestBody.dataShareId
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/datacatalog/shareDataShare'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a Data Share to its external users
      effect: write
      questions:
      - How do I make a Data Share's assets available to its external users?
      - What does switching a Data Share to Shared do?
      instructions:
      - text: Share Data Share {dataShareId} with its external users ({datalakeCrn}, {environmentCrn}).
        slots:
          dataShareId: requestBody.dataShareId
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      - text: Set the status of {dataShareId} to Shared in data lake {datalakeCrn}, environment {environmentCrn}.
        slots:
          dataShareId: requestBody.dataShareId
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/datacatalog/unshareDataShare'].post
  update:
    x-apievangelist-phrasing:
      intent: Temporarily unshare a Data Share
      effect: write
      questions:
      - Can I temporarily hide a Data Share from external users without deleting it?
      - Which Data Share edits require it to be Not Shared first?
      instructions:
      - text: Unshare Data Share {dataShareId} in {datalakeCrn} ({environmentCrn}).
        slots:
          dataShareId: requestBody.dataShareId
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      - text: Set share {dataShareId} to Not Shared for data lake {datalakeCrn}, environment {environmentCrn}.
        slots:
          dataShareId: requestBody.dataShareId
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/datacatalog/addAssetsToDataShare'].post
  update:
    x-apievangelist-phrasing:
      intent: Add assets to an existing Data Share
      effect: write
      questions:
      - How do I add more tables to a Data Share I already created?
      - Does a Data Share need to be unshared before adding assets?
      instructions:
      - text: Add assets {assets} to Data Share {dataShareId} in {datalakeCrn} ({environmentCrn}).
        slots:
          assets: requestBody.assets
          dataShareId: requestBody.dataShareId
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      - text: Include {assets} in existing share {dataShareId} for data lake {datalakeCrn}, environment {environmentCrn}.
        slots:
          assets: requestBody.assets
          dataShareId: requestBody.dataShareId
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/datacatalog/getSuggestedTags'].post
  update:
    x-apievangelist-phrasing:
      intent: Get tags suggested by the compliance profiler
      effect: read
      questions:
      - Which sensitive-data tags has the Data Compliance profiler suggested?
      - Can I see suggested tags for one table or column profiled since a date?
      instructions:
      - text: Get suggested compliance tags in data lake {datalakeCrn}.
        slots:
          datalakeCrn: requestBody.datalakeCrn
      - text: Show profiler-suggested tags for table {tableFQN} in {datalakeCrn} since {profiledSince}.
        slots:
          tableFQN: requestBody.tableFQN
          datalakeCrn: requestBody.datalakeCrn
          profiledSince: requestBody.profiledSince
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/datacatalog/reviewSuggestedTags'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept or reject profiler-suggested tags
      effect: write
      questions:
      - How do I approve or reject the tags the compliance profiler suggested?
      - Can I review suggested tags for many assets at once?
      instructions:
      - text: Apply action {action} to suggested tags on assets {assets} in {datalakeCrn}.
        slots:
          action: requestBody.action
          assets: requestBody.assets
          datalakeCrn: requestBody.datalakeCrn
      - text: Accept the compliance profiler's tag suggestions for {assets} in data lake {datalakeCrn} with action {action}.
        slots:
          assets: requestBody.assets
          datalakeCrn: requestBody.datalakeCrn
          action: requestBody.action
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/datacatalog/removeAssetsFromDataShare'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove assets from a Data Share
      effect: destructive
      questions:
      - How do I take a table out of an existing Data Share?
      - Must the share be Not Shared before removing assets?
      instructions:
      - text: Remove resources {resourceIds} from Data Share {dataShareId} in {datalakeCrn} ({environmentCrn}).
        slots:
          resourceIds: requestBody.resourceIds
          dataShareId: requestBody.dataShareId
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      - text: Drop assets {resourceIds} from share {dataShareId} for data lake {datalakeCrn}, environment {environmentCrn}.
        slots:
          resourceIds: requestBody.resourceIds
          dataShareId: requestBody.dataShareId
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/datacatalog/updateAccessOfExternalUsersOnDataShare'].post
  update:
    x-apievangelist-phrasing:
      intent: Change external users' access expiry on a share
      effect: write
      questions:
      - Can I extend how long an external user can access a Data Share?
      - How do I update access expiration for users already on a share?
      instructions:
      - text: Update access expiry for external users {externalUsers} on Data Share {dataShareId} ({datalakeCrn}, {environmentCrn}).
        slots:
          externalUsers: requestBody.externalUsers
          dataShareId: requestBody.dataShareId
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      - text: Extend the access window of {externalUsers} on share {dataShareId} in data lake {datalakeCrn}, environment {environmentCrn}.
        slots:
          externalUsers: requestBody.externalUsers
          dataShareId: requestBody.dataShareId
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/datacatalog/grantAccessToExternalUsersOnDataShare'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant external users access to a Data Share
      effect: write
      questions:
      - How do I give an outside user access to a Data Share?
      - Can I set an expiration when granting external users access?
      instructions:
      - text: Grant external users {externalUsers} access to Data Share {dataShareId} in {datalakeCrn} ({environmentCrn}).
        slots:
          externalUsers: requestBody.externalUsers
          dataShareId: requestBody.dataShareId
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      - text: Let outside partners {externalUsers} read share {dataShareId} for data lake {datalakeCrn}, environment {environmentCrn}.
        slots:
          externalUsers: requestBody.externalUsers
          dataShareId: requestBody.dataShareId
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/datacatalog/removeAccessOfExternalUsersOnDataShare'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove external users from a Data Share
      effect: destructive
      questions:
      - How do I take away one external user's access to a specific Data Share?
      - Does the Data Share need to be Not Shared before removing users?
      instructions:
      - text: Remove external users {externalUserIds} from Data Share {dataShareId} in {datalakeCrn} ({environmentCrn}).
        slots:
          externalUserIds: requestBody.externalUserIds
          dataShareId: requestBody.dataShareId
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      - text: Revoke share {dataShareId} access for {externalUserIds} in data lake {datalakeCrn}, environment {environmentCrn}.
        slots:
          dataShareId: requestBody.dataShareId
          externalUserIds: requestBody.externalUserIds
          datalakeCrn: requestBody.datalakeCrn
          environmentCrn: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'