OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Onetrust Relationship Management API

6 actions 6 updates phrasing extends openapi/onetrust-relationship-management-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 6

$.info

$.paths['/api/ai-governance/v1/linked-entity-types/entity-types/names/{entityTypeName}/entities/{entityId}/links/pages'].post

$.paths['/api/ai-governance/v1/links'].post

$.paths['/api/ai-governance/v1/links/{linkId}'].get

$.paths['/api/ai-governance/v1/links/{linkId}'].delete

$.paths['/api/inventory-linking/v1/relationship'].post

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 Onetrust Relationship Management API
  version: 1.0.0
extends: openapi/onetrust-relationship-management-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: 5
- target: $.paths['/api/ai-governance/v1/linked-entity-types/entity-types/names/{entityTypeName}/entities/{entityId}/links/pages'].post
  update:
    x-apievangelist-phrasing:
      intent: List relationships of an AI entity
      effect: read
      questions:
      - Which datasets or AI systems are linked to a given model?
      - Can I search the relationship records attached to one AI Governance entity?
      instructions:
      - text: List relationship records for {entityTypeName} {entityId}.
        slots:
          entityTypeName: path.entityTypeName
          entityId: path.entityId
      - text: Search links on {entityTypeName} {entityId} for {fullText}.
        slots:
          entityTypeName: path.entityTypeName
          entityId: path.entityId
          fullText: requestBody.fullText
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ai-governance/v1/links'].post
  update:
    x-apievangelist-phrasing:
      intent: Link two AI Governance entities
      effect: write
      questions:
      - Can I link a model to a dataset in AI Governance?
      - Which entity types can be connected with an AI Governance relationship?
      instructions:
      - text: Link {entity1} to {entity2} with link type {linkTypeId}.
        slots:
          entity1: requestBody.entity1
          entity2: requestBody.entity2
          linkTypeId: query.linkTypeId
      - text: Create an AI Governance relationship of type {linkTypeId} between {entity1} and {entity2}.
        slots:
          linkTypeId: query.linkTypeId
          entity1: requestBody.entity1
          entity2: requestBody.entity2
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ai-governance/v1/links/{linkId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an AI Governance relationship
      effect: read
      questions:
      - Can I read the details of one relationship record between AI entities?
      - What attributes are stored on a single AI Governance link?
      instructions:
      - text: Get relationship record {linkId} of type {linkTypeId}.
        slots:
          linkId: path.linkId
          linkTypeId: query.linkTypeId
      - text: Show AI Governance link {linkId} with type {linkTypeId}.
        slots:
          linkId: path.linkId
          linkTypeId: query.linkTypeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ai-governance/v1/links/{linkId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an AI Governance relationship
      effect: destructive
      questions:
      - Can I unlink a model from a dataset?
      - Does removing a relationship record delete the entities themselves?
      instructions:
      - text: Remove relationship record {linkId} of type {linkTypeId}.
        slots:
          linkId: path.linkId
          linkTypeId: query.linkTypeId
      - text: Unlink AI Governance record {linkId}, type {linkTypeId}.
        slots:
          linkId: path.linkId
          linkTypeId: query.linkTypeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory-linking/v1/relationship'].post
  update:
    x-apievangelist-phrasing:
      intent: Relate two inventory records
      effect: write
      questions:
      - Can I link an asset to a vendor or processing activity in my inventory?
      - Is it possible to label a relationship between two inventory records?
      instructions:
      - text: Relate inventory record {entity1} to {entity2}.
        slots:
          entity1: requestBody.entity1
          entity2: requestBody.entity2
      - text: Link asset {entity1} and vendor {entity2} with label {relationshipLabel}.
        slots:
          entity1: requestBody.entity1
          entity2: requestBody.entity2
          relationshipLabel: requestBody.relationshipLabel
      method: generated
      generated: '2026-09-26'