OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Platform - Inventory Inventory Relationships V2 API

13 actions 13 updates phrasing extends openapi/onetrust-inventory-relationships-v2-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-linking/v1/contextual-entities/inventory/{inventoryId}/pages'].post
$.paths['/api/inventory-linking/v1/contextual-entities/{contextualLinkId}/contextual-entity-types/names/{entityTypeName}'].put
$.paths['/api/inventory-linking/v1/contextual-entities/{contextualLinkId}/contextual-entity-types/names/{entityTypeName}/data-elements'].put
$.paths['/api/inventory-linking/v1/contextual-entities/{contextualLinkId}/contextual-entity-types/names/{entityTypeName}/data-elements/pages'].post
$.paths['/api/inventory-linking/v1/contextual-entities/{contextualLinkId}/contextual-entity-types/{entityTypeId}'].put
$.paths['/api/inventory-linking/v1/contextual-entities/{contextualLinkId}/contextual-entity-types/{entityTypeId}/data-elements'].put
$.paths['/api/inventory-linking/v1/contextual-entities/{contextualLinkId}/contextual-entity-types/{entityTypeId}/data-elements/pages'].post
$.paths['/api/inventory-linking/v1/inventories/relations'].post
$.paths['/api/inventory-linking/v1/relationship-types/names/{relationshipTypeName}/relationship/{relationshipId}'].get
$.paths['/api/inventory-linking/v1/relationship-types/names/{relationshipTypeName}/relationship/{relationshipId}'].delete
$.paths['/api/inventory-linking/v1/relationship-types/{relationshipTypeId}/relationship/{relationshipId}'].get
$.paths['/api/inventory-linking/v1/relationship-types/{relationshipTypeId}/relationship/{relationshipId}'].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 Platform - Inventory Inventory Relationships V2 API
  version: 1.0.0
extends: openapi/onetrust-inventory-relationships-v2-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-linking/v1/contextual-entities/inventory/{inventoryId}/pages'].post
  update:
    x-apievangelist-phrasing:
      intent: List an inventory's relationships
      effect: read
      questions:
      - What other inventories is a given asset or processing activity linked to?
      - Can I page through all relationships of one inventory record?
      instructions:
      - text: List all relationships for inventory {inventoryId}.
        slots:
          inventoryId: path.inventoryId
      - text: Show page {page} of the links on inventory {inventoryId}.
        slots:
          page: query.page
          inventoryId: path.inventoryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory-linking/v1/contextual-entities/{contextualLinkId}/contextual-entity-types/names/{entityTypeName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a relationship by entity type name
      effect: write
      questions:
      - Can I edit a contextual link's attributes when I only know the entity type's name?
      - Is it possible to change the processing activity on a relationship referenced by type name?
      instructions:
      - text: Update relationship {contextualLinkId} of type name {entityTypeName} with attributes {attributes}.
        slots:
          contextualLinkId: path.contextualLinkId
          entityTypeName: path.entityTypeName
          attributes: requestBody.attributes
      - text: Set processing activity {processingActivityId} on link {contextualLinkId} (type name {entityTypeName}).
        slots:
          processingActivityId: requestBody.processingActivityId
          contextualLinkId: path.contextualLinkId
          entityTypeName: path.entityTypeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory-linking/v1/contextual-entities/{contextualLinkId}/contextual-entity-types/names/{entityTypeName}/data-elements'].put
  update:
    x-apievangelist-phrasing:
      intent: Link personal data to a relationship by type name
      effect: write
      questions:
      - Can I attach or detach personal data elements on a relationship identified by entity type name?
      - Where do I link data elements to a contextual link when I have the type name, not the type ID?
      instructions:
      - text: Link or unlink personal data on relationship {contextualLinkId} using type name {entityTypeName}.
        slots:
          contextualLinkId: path.contextualLinkId
          entityTypeName: path.entityTypeName
      - text: Change the personal data tied to link {contextualLinkId} of type name {entityTypeName}.
        slots:
          contextualLinkId: path.contextualLinkId
          entityTypeName: path.entityTypeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory-linking/v1/contextual-entities/{contextualLinkId}/contextual-entity-types/names/{entityTypeName}/data-elements/pages'].post
  update:
    x-apievangelist-phrasing:
      intent: List a relationship's personal data by type name
      effect: read
      questions:
      - Which personal data elements are tied to a relationship, looked up by entity type name?
      - Can I page personal data on a link when I know the type name?
      instructions:
      - text: List personal data on relationship {contextualLinkId} with type name {entityTypeName}.
        slots:
          contextualLinkId: path.contextualLinkId
          entityTypeName: path.entityTypeName
      - text: Show page {page} of data elements for link {contextualLinkId}, type name {entityTypeName}.
        slots:
          page: query.page
          contextualLinkId: path.contextualLinkId
          entityTypeName: path.entityTypeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory-linking/v1/contextual-entities/{contextualLinkId}/contextual-entity-types/{entityTypeId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a relationship by entity type ID
      effect: write
      questions:
      - Can I edit a contextual link's attributes using the entity type's ID?
      - Is changing the processing activity on a relationship possible by type ID?
      instructions:
      - text: Update relationship {contextualLinkId} of type ID {entityTypeId} with attributes {attributes}.
        slots:
          contextualLinkId: path.contextualLinkId
          entityTypeId: path.entityTypeId
          attributes: requestBody.attributes
      - text: Set processing activity {processingActivityId} on link {contextualLinkId} for type ID {entityTypeId}.
        slots:
          processingActivityId: requestBody.processingActivityId
          contextualLinkId: path.contextualLinkId
          entityTypeId: path.entityTypeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory-linking/v1/contextual-entities/{contextualLinkId}/contextual-entity-types/{entityTypeId}/data-elements'].put
  update:
    x-apievangelist-phrasing:
      intent: Link personal data to a relationship by type ID
      effect: write
      questions:
      - I only have the numeric entity type ID — where do I add or drop data elements on that contextual link?
      - Which call links data elements to a contextual link by type ID?
      instructions:
      - text: Link or unlink personal data on relationship {contextualLinkId} using type ID {entityTypeId}.
        slots:
          contextualLinkId: path.contextualLinkId
          entityTypeId: path.entityTypeId
      - text: Change the personal data tied to link {contextualLinkId}, entity type ID {entityTypeId}.
        slots:
          contextualLinkId: path.contextualLinkId
          entityTypeId: path.entityTypeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory-linking/v1/contextual-entities/{contextualLinkId}/contextual-entity-types/{entityTypeId}/data-elements/pages'].post
  update:
    x-apievangelist-phrasing:
      intent: List a relationship's personal data by type ID
      effect: read
      questions:
      - Given a contextual link and its entity type ID, what data elements does it carry?
      - Can I sort the personal data on a link identified by type ID?
      instructions:
      - text: List personal data on relationship {contextualLinkId} with type ID {entityTypeId}.
        slots:
          contextualLinkId: path.contextualLinkId
          entityTypeId: path.entityTypeId
      - text: Show data elements for link {contextualLinkId}, type ID {entityTypeId}, sorted by {sort}.
        slots:
          contextualLinkId: path.contextualLinkId
          entityTypeId: path.entityTypeId
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory-linking/v1/inventories/relations'].post
  update:
    x-apievangelist-phrasing:
      intent: Link inventories together
      effect: write
      questions:
      - Can I create a two-way link between an asset and several other inventories?
      - What link type name and label are needed to relate two inventory records?
      instructions:
      - text: Link inventory {sourceInventory} to {targetInventory} as {linkTypeName} labeled {linkTypeLabel}.
        slots:
          sourceInventory: requestBody.sourceInventory
          targetInventory: requestBody.targetInventory
          linkTypeName: requestBody.linkTypeName
          linkTypeLabel: requestBody.linkTypeLabel
      - text: Create a {linkTypeLabel} relationship from {sourceInventory} to {targetInventory} using link type {linkTypeName}.
        slots:
          linkTypeLabel: requestBody.linkTypeLabel
          sourceInventory: requestBody.sourceInventory
          targetInventory: requestBody.targetInventory
          linkTypeName: requestBody.linkTypeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory-linking/v1/relationship-types/names/{relationshipTypeName}/relationship/{relationshipId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a relationship by relationship type name
      effect: read
      questions:
      - Can I read a relationship's details when I know the relationship type name?
      - What does a link between two entities look like, fetched by relationship type name?
      instructions:
      - text: Get relationship {relationshipId} of type name {relationshipTypeName}.
        slots:
          relationshipId: path.relationshipId
          relationshipTypeName: path.relationshipTypeName
      - text: Show details of link {relationshipId} under relationship type name {relationshipTypeName}.
        slots:
          relationshipId: path.relationshipId
          relationshipTypeName: path.relationshipTypeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory-linking/v1/relationship-types/names/{relationshipTypeName}/relationship/{relationshipId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a relationship by relationship type name
      effect: destructive
      questions:
      - Can I remove a link between two entities using the relationship type name?
      - Is deleting a relationship by type name permanent?
      instructions:
      - text: Delete relationship {relationshipId} of type name {relationshipTypeName}.
        slots:
          relationshipId: path.relationshipId
          relationshipTypeName: path.relationshipTypeName
      - text: Remove the link {relationshipId} under relationship type name {relationshipTypeName}.
        slots:
          relationshipId: path.relationshipId
          relationshipTypeName: path.relationshipTypeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory-linking/v1/relationship-types/{relationshipTypeId}/relationship/{relationshipId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a relationship by relationship type ID
      effect: read
      questions:
      - Can I read a relationship's details using the relationship type ID?
      - Which call fetches one entity link when I have the relationship type ID?
      instructions:
      - text: Get relationship {relationshipId} of type ID {relationshipTypeId}.
        slots:
          relationshipId: path.relationshipId
          relationshipTypeId: path.relationshipTypeId
      - text: Show details of link {relationshipId} under relationship type ID {relationshipTypeId}.
        slots:
          relationshipId: path.relationshipId
          relationshipTypeId: path.relationshipTypeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory-linking/v1/relationship-types/{relationshipTypeId}/relationship/{relationshipId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a relationship by relationship type ID
      effect: destructive
      questions:
      - Is it possible to delete an entity link when all I know is the numeric relationship type ID?
      - Which call unlinks two entities when I know the relationship type ID?
      instructions:
      - text: Delete relationship {relationshipId} of type ID {relationshipTypeId}.
        slots:
          relationshipId: path.relationshipId
          relationshipTypeId: path.relationshipTypeId
      - text: Remove the link {relationshipId} under relationship type ID {relationshipTypeId}.
        slots:
          relationshipId: path.relationshipId
          relationshipTypeId: path.relationshipTypeId
      method: generated
      generated: '2026-09-26'