API Evangelist conversational phrasing for Onetrust Inventory API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Onetrust Inventory API
  version: 1.0.0
extends: openapi/onetrust-inventory-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: 12
- target: $.paths['/api/inventory/v2/inventories/{inventoryId}/attachments'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach documents to an inventory record
      effect: write
      questions:
      - How do I link existing attachments to an inventory record?
      - Where do attached documents show up on an inventory's details page?
      instructions:
      - text: Attach existing documents to inventory record {inventoryId}.
        slots:
          inventoryId: path.inventoryId
      - text: Add attachments to the Documents tab of inventory {inventoryId}.
        slots:
          inventoryId: path.inventoryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventories/{schemaName}'].get
  update:
    x-apievangelist-phrasing:
      intent: List inventories of a type
      effect: read
      questions:
      - What assets or processing activities are in my inventory?
      - Can I include inventory records marked for deletion in the list?
      - How do I page through inventories of one type with a simple filter string?
      instructions:
      - text: List all {schemaName} inventories.
        slots:
          schemaName: path.schemaName
      - text: List {schemaName} inventories matching {filter}.
        slots:
          schemaName: path.schemaName
          filter: query.filter
      - text: Show page {page} of {schemaName} inventories.
        slots:
          page: query.page
          schemaName: path.schemaName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventories/{schemaName}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an inventory record
      effect: write
      questions:
      - How do I add a new asset or processing activity to my inventory?
      - Can I create an inventory record as a master record?
      instructions:
      - text: Create a new {schemaName} inventory record.
        slots:
          schemaName: path.schemaName
      - text: 'Create a {schemaName} inventory as master: {createAsMaster}.'
        slots:
          schemaName: path.schemaName
          createAsMaster: query.createAsMaster
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventories/{schemaName}/business-key'].put
  update:
    x-apievangelist-phrasing:
      intent: Upsert an inventory by external ID
      effect: write
      questions:
      - How do I sync an inventory record from another system, creating it if it doesn't exist?
      - Can I update an inventory using my own business key instead of the OneTrust ID?
      instructions:
      - text: Upsert a {schemaName} inventory by its business key.
        slots:
          schemaName: path.schemaName
      - text: Create or update the {schemaName} record matched on external ID.
        slots:
          schemaName: path.schemaName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventories/{schemaName}/criteria'].post
  update:
    x-apievangelist-phrasing:
      intent: Search inventories by criteria
      effect: read
      questions:
      - How do I find inventory records matching several attribute filters?
      - Which inventories of a type meet structured filter criteria?
      instructions:
      - text: Search {schemaName} inventories using criteria {filters}.
        slots:
          schemaName: path.schemaName
          filters: requestBody.filters
      - text: Query {schemaName} records by filter criteria {filters}, page {page}.
        slots:
          schemaName: path.schemaName
          filters: requestBody.filters
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventories/{schemaName}/reference/{externalId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an inventory by external ID
      effect: read
      questions:
      - How do I look up an inventory record using the ID from my own system?
      - Can I fetch an asset by its external reference?
      instructions:
      - text: Get the {schemaName} inventory with external ID {externalId}.
        slots:
          schemaName: path.schemaName
          externalId: path.externalId
      - text: Look up {schemaName} record by external reference {externalId}.
        slots:
          schemaName: path.schemaName
          externalId: path.externalId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventories/{schemaName}/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an inventory by ID
      effect: read
      questions:
      - What details are stored on one inventory record?
      - How do I open a specific asset or vendor record by its OneTrust ID?
      instructions:
      - text: Show {schemaName} inventory {id}.
        slots:
          schemaName: path.schemaName
          id: path.id
      - text: Get the details of inventory record {id} of type {schemaName}.
        slots:
          id: path.id
          schemaName: path.schemaName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventories/{schemaName}/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an inventory by ID
      effect: write
      questions:
      - How do I change fields on an existing inventory record?
      - Do I need to send every field when updating an inventory, or only the changed ones?
      instructions:
      - text: Update {schemaName} inventory {id} with {inventoryRequest}.
        slots:
          schemaName: path.schemaName
          id: path.id
          inventoryRequest: requestBody.inventoryRequest
      - text: Change the fields of inventory record {id} of type {schemaName}.
        slots:
          id: path.id
          schemaName: path.schemaName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventories/{schemaName}/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an inventory record
      effect: destructive
      questions:
      - How do I delete an asset or processing activity from my inventory?
      - Can I record a reason when deleting an inventory record?
      instructions:
      - text: Delete {schemaName} inventory {id}.
        slots:
          schemaName: path.schemaName
          id: path.id
      - text: Delete inventory {id} of type {schemaName} with reason {deleteReason}.
        slots:
          id: path.id
          schemaName: path.schemaName
          deleteReason: query.deleteReason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventories/{schemaName}/{id}/copy'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy an inventory record
      effect: write
      questions:
      - How do I duplicate an existing inventory record?
      - Can a copied inventory bring its related records along or become a child?
      instructions:
      - text: Copy {schemaName} inventory {id}.
        slots:
          schemaName: path.schemaName
          id: path.id
      - text: Duplicate inventory {id} of type {schemaName} as {name}, copying related records.
        slots:
          id: path.id
          schemaName: path.schemaName
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventories/{schemaName}/{id}/status'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an inventory record's status
      effect: write
      questions:
      - How do I move an inventory record to a different status?
      - Can I set an asset's status without editing its other fields?
      instructions:
      - text: Set the status of {schemaName} inventory {id} to {key}.
        slots:
          schemaName: path.schemaName
          id: path.id
          key: requestBody.key
      - text: Change inventory {id} of type {schemaName} to status {key}.
        slots:
          id: path.id
          schemaName: path.schemaName
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/inventory/v2/schemas/attributes/{attributeId}/values/{valueId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an inventory attribute's option value
      effect: read
      questions:
      - How do I look up a single option value defined on an inventory schema attribute?
      - Can I see the current name of one picklist option on an inventory attribute before renaming it?
      - What details come back for a specific attribute option in the inventory schema?
      instructions:
      - text: Get option value {valueId} of inventory attribute {attributeId}.
        slots:
          valueId: path.valueId
          attributeId: path.attributeId
      - text: Show me the schema attribute option {valueId} under attribute {attributeId} so I can check its name.
        slots:
          valueId: path.valueId
          attributeId: path.attributeId
      method: generated
      generated: '2026-10-01'