OneTrust · OpenAPI Overlay 1.0.0

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

13 actions 13 updates phrasing extends openapi/onetrust-inventory-relationships-v1-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 13

$.info

$.paths['/api/inventory/v2/inventories/{id}/associations/{associationId}'].put

$.paths['/api/inventory/v2/inventories/{id}/personal-data'].get

$.paths['/api/inventory/v2/inventories/{id}/personal-data'].post

$.paths['/api/inventory/v2/inventories/{id}/personal-data'].delete

$.paths['/api/inventory/v2/inventories/{id}/relations'].put

$.paths['/api/inventory/v2/inventories/{id}/relations'].post

$.paths['/api/inventory/v2/inventories/{id}/relations'].delete

$.paths['/api/inventory/v2/inventories/{id}/relations/{inventoryType}'].get

$.paths['/api/inventory/v2/inventories/{inventoryId}/personal-data/{personalDataAssociationId}/attributes'].get

$.paths['/api/inventory/v2/inventories/{schemaName}/{id}/relations/{relatedSchemaName}/{linkId}/attributes'].put

$.paths['/api/inventory/v2/inventories/{type}/{inventoryId}/control-implementations'].post

$.paths['/api/inventory/v2/inventories-personal-data/{personalDataAssociationId}'].put

OpenAPI Overlay

# 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-relationships-v1-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: 12
- target: $.paths['/api/inventory/v2/inventories/{id}/associations/{associationId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an existing link between two inventories
      effect: write
      questions:
      - How do I change the relation type on a link between two inventory records?
      - Can I edit an inventory link after it has been created?
      instructions:
      - text: Change link {associationId} on inventory {id} to relation {relation}.
        slots:
          associationId: path.associationId
          id: path.id
          relation: requestBody.relation
      - text: Update the relation of inventory {id}'s existing link {associationId}.
        slots:
          id: path.id
          associationId: path.associationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventories/{id}/personal-data'].get
  update:
    x-apievangelist-phrasing:
      intent: List personal data linked to an inventory
      effect: read
      questions:
      - Which personal data items are linked to this asset or processing activity?
      - Can I page through the personal data links on an inventory record?
      instructions:
      - text: List the personal data items linked to inventory {id}.
        slots:
          id: path.id
      - text: Show page {page} of personal data links for inventory {id}.
        slots:
          page: query.page
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventories/{id}/personal-data'].post
  update:
    x-apievangelist-phrasing:
      intent: Link personal data items to an inventory
      effect: write
      questions:
      - How do I record that an asset processes certain personal data?
      - Can I attach personal data elements to an inventory record?
      instructions:
      - text: Link personal data items to inventory {id}.
        slots:
          id: path.id
      - text: Attach personal data to inventory {id} using generator {generator}.
        slots:
          id: path.id
          generator: query.generator
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventories/{id}/personal-data'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete personal data links from an inventory
      effect: destructive
      questions:
      - How do I unlink personal data from an inventory record?
      - Is removing a personal data link from an inventory permanent?
      instructions:
      - text: Permanently remove the personal data links on inventory {id}.
        slots:
          id: path.id
      - text: Unlink personal data from inventory {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventories/{id}/relations'].put
  update:
    x-apievangelist-phrasing:
      intent: Link inventories to each other (PUT variant)
      effect: write
      questions:
      - Is there a PUT call to link an inventory to other inventories?
      - Can I replace-style link an inventory to several others of one entity type with PUT?
      instructions:
      - text: Using PUT, link inventory {id} to other inventories of type {entityType}.
        slots:
          id: path.id
          entityType: query.entityType
      - text: Send a PUT to create bidirectional links from inventory {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventories/{id}/relations'].post
  update:
    x-apievangelist-phrasing:
      intent: Link inventories to each other (POST variant)
      effect: write
      questions:
      - How do I create a two-way link between a vendor and an asset inventory?
      - Can I link one inventory to several other inventories in one POST?
      instructions:
      - text: Create new bidirectional links from inventory {id} to inventories of type {entityType}.
        slots:
          id: path.id
          entityType: query.entityType
      - text: POST a new link between inventory {id} and other inventories.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventories/{id}/relations'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete links between inventories
      effect: destructive
      questions:
      - How do I break the link between two inventory records?
      - Is deleting an inventory-to-inventory link reversible?
      instructions:
      - text: Delete the inventory links on inventory {id}.
        slots:
          id: path.id
      - text: Permanently unlink inventory {id} from its related inventories.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventories/{id}/relations/{inventoryType}'].get
  update:
    x-apievangelist-phrasing:
      intent: List an inventory's links of a given type
      effect: read
      questions:
      - Which vendors are linked to a given processing activity?
      - Can I see only the related inventories of one type for a record?
      instructions:
      - text: List inventory {id}'s links to {inventoryType} inventories.
        slots:
          id: path.id
          inventoryType: path.inventoryType
      - text: Show page {page} of {inventoryType} records linked to inventory {id}.
        slots:
          page: query.page
          inventoryType: path.inventoryType
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventories/{inventoryId}/personal-data/{personalDataAssociationId}/attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get attributes tracked on a personal data link
      effect: read
      questions:
      - What attribute values are recorded on an inventory's personal data link?
      - Where do I read the tracked attributes of one personal data association?
      instructions:
      - text: Show the attribute values on personal data link {personalDataAssociationId} of inventory {inventoryId}.
        slots:
          personalDataAssociationId: path.personalDataAssociationId
          inventoryId: path.inventoryId
      - text: Get tracked link attributes for association {personalDataAssociationId} on inventory {inventoryId}.
        slots:
          personalDataAssociationId: path.personalDataAssociationId
          inventoryId: path.inventoryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventories/{schemaName}/{id}/relations/{relatedSchemaName}/{linkId}/attributes'].put
  update:
    x-apievangelist-phrasing:
      intent: Update attributes on an inventory relation link
      effect: write
      questions:
      - How do I change attribute values tracked on a link between two schemas?
      - Can I edit link attributes addressed by schema name and link ID?
      instructions:
      - text: Set link attributes {linkAttributes} on link {linkId} from {schemaName} {id} to {relatedSchemaName}.
        slots:
          linkAttributes: requestBody.linkAttributes
          linkId: path.linkId
          schemaName: path.schemaName
          id: path.id
          relatedSchemaName: path.relatedSchemaName
      - text: Update the tracked attributes of relation link {linkId} between {schemaName} record {id} and {relatedSchemaName}.
        slots:
          linkId: path.linkId
          schemaName: path.schemaName
          id: path.id
          relatedSchemaName: path.relatedSchemaName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventories/{type}/{inventoryId}/control-implementations'].post
  update:
    x-apievangelist-phrasing:
      intent: Add control implementations to an inventory
      effect: write
      questions:
      - How do I apply master controls to an asset or vendor inventory?
      - Can I set a status on control implementations when I add them to an inventory?
      instructions:
      - text: Implement controls {controlIds} on {type} inventory {inventoryId}.
        slots:
          controlIds: requestBody.controlIds
          type: path.type
          inventoryId: path.inventoryId
      - text: Add controls {controlIds} to {type} {inventoryId} with status {status}.
        slots:
          controlIds: requestBody.controlIds
          type: path.type
          inventoryId: path.inventoryId
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/inventories-personal-data/{personalDataAssociationId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update advanced attributes of a personal data association
      effect: write
      questions:
      - How do I update the advanced attributes of personal data linked to an inventory?
      - Which inventory type do I need to supply when editing a personal data association?
      instructions:
      - text: Update advanced attributes of personal data association {personalDataAssociationId} on a {inventoryType} inventory.
        slots:
          personalDataAssociationId: path.personalDataAssociationId
          inventoryType: query.inventoryType
      - text: Set advanced attributes {linkAttributes} on personal data association {personalDataAssociationId} ({inventoryType}).
        slots:
          linkAttributes: requestBody.linkAttributes
          personalDataAssociationId: path.personalDataAssociationId
          inventoryType: query.inventoryType
      method: generated
      generated: '2026-09-26'