OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Privacy Automation - Data Mapping Automation Inventory…

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

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/api/inventory/v2/inventories/{inventoryId}/set-as-parent'].put
$.paths['/api/inventory/v2/inventories/{inventoryId}/unset-as-parent'].put
$.paths['/api/inventory/v2/inventories/{parentInventoryId}/link-assets'].post
$.paths['/api/inventory/v2/inventories/{parentInventoryId}/link-legal-entities'].post
$.paths['/api/inventory/v2/inventories/{parentInventoryId}/link-processing-activities'].post
$.paths['/api/inventory/v2/inventories/{parentInventoryId}/link-vendors'].post
$.paths['/api/inventory/v2/inventory-hierarchies/{rootInventoryId}'].get
$.paths['/api/inventory/v2/inventory-hierarchies/{rootInventoryId}'].delete

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 Privacy Automation - Data Mapping Automation Inventory…
  version: 1.0.0
extends: openapi/onetrust-inventory-hierarchies-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: 8
- target: $.paths['/api/inventory/v2/inventories/{inventoryId}/set-as-parent'].put
  update:
    x-apievangelist-phrasing:
      intent: Mark an inventory as a parent
      effect: write
      questions:
      - How do I turn an existing inventory record into a parent so others can nest under it?
      - Can any inventory type be set as a parent?
      instructions:
      - text: Set {inventoryType} inventory {inventoryId} as a parent.
        slots:
          inventoryType: query.inventoryType
          inventoryId: path.inventoryId
      - text: Make inventory {inventoryId} a parent inventory.
        slots:
          inventoryId: path.inventoryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventories/{inventoryId}/unset-as-parent'].put
  update:
    x-apievangelist-phrasing:
      intent: Stop an inventory from being a parent
      effect: write
      questions:
      - How do I remove parent status from an inventory record?
      - Can I demote a parent inventory back to a normal one?
      instructions:
      - text: Unset {inventoryType} inventory {inventoryId} as a parent.
        slots:
          inventoryType: query.inventoryType
          inventoryId: path.inventoryId
      - text: Remove parent status from inventory {inventoryId}.
        slots:
          inventoryId: path.inventoryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventories/{parentInventoryId}/link-assets'].post
  update:
    x-apievangelist-phrasing:
      intent: Nest an asset under a parent asset
      effect: write
      questions:
      - How do I make one asset a child of another asset?
      - Can I build an asset hierarchy in my data map?
      instructions:
      - text: Link child assets under parent asset {parentInventoryId}.
        slots:
          parentInventoryId: path.parentInventoryId
      - text: Add an existing asset as a child of asset {parentInventoryId}.
        slots:
          parentInventoryId: path.parentInventoryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventories/{parentInventoryId}/link-legal-entities'].post
  update:
    x-apievangelist-phrasing:
      intent: Nest a legal entity under a parent legal entity
      effect: write
      questions:
      - How do I model a subsidiary as a child of its parent legal entity?
      - Can legal entities be arranged in a parent-child hierarchy?
      instructions:
      - text: Link child legal entities under parent legal entity {parentInventoryId}.
        slots:
          parentInventoryId: path.parentInventoryId
      - text: Make an existing legal entity a subsidiary of {parentInventoryId}.
        slots:
          parentInventoryId: path.parentInventoryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventories/{parentInventoryId}/link-processing-activities'].post
  update:
    x-apievangelist-phrasing:
      intent: Nest a processing activity under a parent activity
      effect: write
      questions:
      - How do I group processing activities under a parent activity?
      - Can a processing activity be a child of another processing activity?
      instructions:
      - text: Link child processing activities under parent activity {parentInventoryId}.
        slots:
          parentInventoryId: path.parentInventoryId
      - text: Nest an existing processing activity beneath {parentInventoryId}.
        slots:
          parentInventoryId: path.parentInventoryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventories/{parentInventoryId}/link-vendors'].post
  update:
    x-apievangelist-phrasing:
      intent: Nest a vendor under a parent vendor
      effect: write
      questions:
      - How do I group a vendor's affiliates under a parent vendor record?
      - Can vendors be organized into a parent-child hierarchy?
      instructions:
      - text: Link child vendors under parent vendor {parentInventoryId}.
        slots:
          parentInventoryId: path.parentInventoryId
      - text: Place an existing vendor beneath parent vendor {parentInventoryId}.
        slots:
          parentInventoryId: path.parentInventoryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventory-hierarchies/{rootInventoryId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List child inventories under a root inventory
      effect: read
      questions:
      - What child records sit under a given root inventory?
      - Can I page through an inventory hierarchy by schema type?
      instructions:
      - text: List the children of {inventoryType} root inventory {rootInventoryId}.
        slots:
          inventoryType: query.inventoryType
          rootInventoryId: path.rootInventoryId
      - text: Show the hierarchy below root inventory {rootInventoryId}, page {page}.
        slots:
          rootInventoryId: path.rootInventoryId
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventory-hierarchies/{rootInventoryId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a child inventory from a hierarchy
      effect: destructive
      questions:
      - How do I take a child record out of an inventory hierarchy?
      - Can I detach one child inventory from its root without deleting it?
      instructions:
      - text: Unlink child {childInventoryId} from root inventory {rootInventoryId}.
        slots:
          childInventoryId: query.childInventoryId
          rootInventoryId: path.rootInventoryId
      - text: Remove {inventoryType} child {childInventoryId} from the hierarchy under {rootInventoryId}.
        slots:
          inventoryType: query.inventoryType
          childInventoryId: query.childInventoryId
          rootInventoryId: path.rootInventoryId
      method: generated
      generated: '2026-09-26'