API Evangelist conversational phrasing for Data Use Governance - Data Catalog Data Assets API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Data Use Governance - Data Catalog Data Assets API
  version: 1.0.0
extends: openapi/onetrust-data-assets-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: 6
- target: $.paths['/api/data-governance/v1/data-assets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or upsert a data asset
      effect: write
      questions:
      - How do I add a table or column to the data catalog under its parent?
      - Does creating a data asset update it if it already exists?
      instructions:
      - text: Create data asset {name} of type {type} under parent {parentId} in data source {dataSource}.
        slots:
          name: requestBody.name
          type: requestBody.type
          parentId: requestBody.parentId
          dataSource: requestBody.dataSource
      - text: Upsert {type} asset {name} beneath {parentId} from source {dataSource}, flagged PII {pii}.
        slots:
          type: requestBody.type
          name: requestBody.name
          parentId: requestBody.parentId
          dataSource: requestBody.dataSource
          pii: requestBody.pii
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/data-governance/v1/data-assets/{dataAssetId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data asset
      effect: read
      questions:
      - Which terms and tags are associated with a given data asset?
      - Can I see a catalog asset's data source and extra attributes?
      instructions:
      - text: Get data asset {dataAssetId}.
        slots:
          dataAssetId: path.dataAssetId
      - text: Show the terms, tags and source of data asset {dataAssetId}.
        slots:
          dataAssetId: path.dataAssetId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/data-governance/v1/data-assets/{dataAssetId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data asset and its children
      effect: destructive
      questions:
      - Does deleting a data asset also remove its child objects?
      - Can I remove an asset from the data catalog?
      instructions:
      - text: Delete data asset {dataAssetId}.
        slots:
          dataAssetId: path.dataAssetId
      - text: Remove catalog asset {dataAssetId} along with its child objects.
        slots:
          dataAssetId: path.dataAssetId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/data-governance/v1/data-assets/{dataAssetId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Modify a data asset
      effect: write
      questions:
      - Can I change a data asset's owners and stewards?
      - Will modifying an asset replace its existing terms and tags?
      instructions:
      - text: Update the short description of data asset {dataAssetId} to {shortDescription}.
        slots:
          dataAssetId: path.dataAssetId
          shortDescription: requestBody.shortDescription
      - text: Set business owners {businessOwners} and data stewards {dataStewards} on asset {dataAssetId}.
        slots:
          businessOwners: requestBody.businessOwners
          dataStewards: requestBody.dataStewards
          dataAssetId: path.dataAssetId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/data-governance/v1/data-assets/{dataAssetId}/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Tag a data asset
      effect: write
      questions:
      - Can I add tags to a data asset without replacing its other details?
      - Which call assigns a list of tags to one catalog asset?
      instructions:
      - text: Add tags to data asset {dataAssetId}.
        slots:
          dataAssetId: path.dataAssetId
      - text: Associate these tags with catalog asset {dataAssetId}.
        slots:
          dataAssetId: path.dataAssetId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/data-governance/v1/data-assets/{dataAssetId}/terms'].post
  update:
    x-apievangelist-phrasing:
      intent: Link glossary terms to a data asset
      effect: write
      questions:
      - Can I attach business glossary terms to a data asset?
      - Which call assigns a list of terms to one catalog asset?
      instructions:
      - text: Add glossary terms to data asset {dataAssetId}.
        slots:
          dataAssetId: path.dataAssetId
      - text: Associate these business terms with catalog asset {dataAssetId}.
        slots:
          dataAssetId: path.dataAssetId
      method: generated
      generated: '2026-09-26'