OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Platform - Object Manager Object Relationship Management API

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

$.info
$.paths['/v1/links'].post
$.paths['/v1/links/{linkId}'].get
$.paths['/v1/links/{linkId}'].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 - Object Manager Object Relationship Management API
  version: 1.0.0
extends: openapi/onetrust-object-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: 3
- target: $.paths['/v1/links'].post
  update:
    x-apievangelist-phrasing:
      intent: Link two Object Manager records
      effect: write
      questions:
      - Can I relate a project to a model or dataset?
      - What link type ID do I need to connect two objects?
      instructions:
      - text: Link {entity1} to {entity2} with link type {linkTypeId}.
        slots:
          entity1: requestBody.entity1
          entity2: requestBody.entity2
          linkTypeId: query.linkTypeId
      - text: Create a relationship record 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['/v1/links/{linkId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a relationship record
      effect: read
      questions:
      - What are the details of a link between two objects?
      - Can I read a relationship record for a dataset link?
      instructions:
      - text: Get relationship record {linkId} of link type {linkTypeId}.
        slots:
          linkId: path.linkId
          linkTypeId: query.linkTypeId
      - text: Show link {linkId} (type {linkTypeId}).
        slots:
          linkId: path.linkId
          linkTypeId: query.linkTypeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/links/{linkId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a relationship record
      effect: destructive
      questions:
      - Can I unlink a model from a project?
      - Is removing a relationship record between objects permanent?
      instructions:
      - text: Delete relationship record {linkId} of link type {linkTypeId}.
        slots:
          linkId: path.linkId
          linkTypeId: query.linkTypeId
      - text: Unlink the objects joined by link {linkId}, type {linkTypeId}.
        slots:
          linkId: path.linkId
          linkTypeId: query.linkTypeId
      method: generated
      generated: '2026-09-26'