OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Platform - Object Manager Object Relationship Type…

4 actions 4 updates phrasing extends openapi/onetrust-object-relationship-type-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/entity-link-types'].post
$.paths['/v1/entity-link-types/search'].post
$.paths['/v1/entity-link-types/{entityLinkTypeId}'].get

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 Type…
  version: 1.0.0
extends: openapi/onetrust-object-relationship-type-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/entity-link-types'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a relationship type between objects
      effect: write
      questions:
      - Can I define a new kind of relationship between Projects and Models?
      - Is it possible to name each direction of an object relationship type?
      instructions:
      - text: Create relationship type {name} with associations {linkAssociations}.
        slots:
          name: requestBody.name
          linkAssociations: requestBody.linkAssociations
      - text: Define link type {name} where forward reads {entityType1ToEntityType2EntityLinkName}, associations {linkAssociations}.
        slots:
          name: requestBody.name
          entityType1ToEntityType2EntityLinkName: requestBody.entityType1ToEntityType2EntityLinkName
          linkAssociations: requestBody.linkAssociations
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/entity-link-types/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search relationship types
      effect: read
      questions:
      - Which relationship types are defined between my objects?
      - Can I search relationship types by keyword?
      instructions:
      - text: List all relationship types.
      - text: Search relationship types for {fullText}.
        slots:
          fullText: requestBody.fullText
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/entity-link-types/{entityLinkTypeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a relationship type
      effect: read
      questions:
      - Can I see the details of one relationship type by ID?
      - Which object types does a given relationship type connect?
      instructions:
      - text: Get relationship type {entityLinkTypeId}.
        slots:
          entityLinkTypeId: path.entityLinkTypeId
      - text: Show which objects link type {entityLinkTypeId} connects.
        slots:
          entityLinkTypeId: path.entityLinkTypeId
      method: generated
      generated: '2026-09-26'