OneTrust · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/onetrust-inventory-management-controller-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 4

$.info
$.paths['/api/inventory/v2/inventories/{schemaName}/business-keys'].post
$.paths['/api/inventory/v2/inventories/{schemaName}/identifiers'].post
$.paths['/api/inventory/v2/vendors/search'].get

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-management-controller-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: 3
- target: $.paths['/api/inventory/v2/inventories/{schemaName}/business-keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Resolve business keys to inventory IDs
      effect: read
      questions:
      - How do I translate my own business keys into OneTrust inventory IDs?
      - Can I look up the IDs of several processing activities from their business keys?
      instructions:
      - text: Get the inventory IDs for these {schemaName} business keys.
        slots:
          schemaName: path.schemaName
      - text: Resolve business keys to {schemaName} IDs within org {orgGroupId}.
        slots:
          schemaName: path.schemaName
          orgGroupId: query.orgGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventories/{schemaName}/identifiers'].post
  update:
    x-apievangelist-phrasing:
      intent: List inventory identifiers with filters
      effect: read
      questions:
      - How do I get just the identifiers of inventory records matching a search?
      - Can I filter inventory identifiers by org and search text?
      instructions:
      - text: List {schemaName} identifiers with paging {pageable}.
        slots:
          schemaName: path.schemaName
          pageable: query.pageable
      - text: Get {schemaName} identifiers matching {searchText}, paged by {pageable}.
        slots:
          schemaName: path.schemaName
          searchText: requestBody.searchText
          pageable: query.pageable
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/vendors/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search vendors by name or website
      effect: read
      questions:
      - Is a vendor already in our inventory under this name?
      - Can I find a vendor by its website domain?
      instructions:
      - text: Search vendors named {name}.
        slots:
          name: query.name
      - text: Find the vendor with website {website}.
        slots:
          website: query.website
      method: generated
      generated: '2026-09-26'