OneTrust · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/v1/entities'].post
$.paths['/v1/entities/search'].post
$.paths['/v1/entities/{entityId}'].get
$.paths['/v1/entities/{entityId}'].delete
$.paths['/v1/entities/{entityId}'].patch
$.paths['/v1/entity-basic-details/search'].post

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 Management API
  version: 1.0.0
extends: openapi/onetrust-object-management-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/v1/entities'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an object record
      effect: write
      questions:
      - Can I create a Project, Model or Dataset record in Object Manager?
      - Which object types can be created through the object API?
      instructions:
      - text: Create a {entityTypeName} object named {name}.
        slots:
          entityTypeName: query.entityTypeName
          name: requestBody.name
      - text: Add a new object record {name} in organization {organization}.
        slots:
          name: requestBody.name
          organization: requestBody.organization
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/entities/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search objects with full details
      effect: read
      questions:
      - Can I search object records and get every attribute back?
      - Is it possible to choose which fields come back when searching objects?
      instructions:
      - text: Search {entityTypeName} objects and return full details.
        slots:
          entityTypeName: query.entityTypeName
      - text: Find objects matching {queryRequest}, returning fields {requestedFields}.
        slots:
          queryRequest: requestBody.queryRequest
          requestedFields: requestBody.requestedFields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/entities/{entityId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an object record
      effect: read
      questions:
      - Can I fetch one object record by its ID with its attributes?
      - When was a given Model or Dataset record created?
      instructions:
      - text: Get object {entityId}.
        slots:
          entityId: path.entityId
      - text: Show {entityTypeName} record {entityId}.
        slots:
          entityTypeName: query.entityTypeName
          entityId: path.entityId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/entities/{entityId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an object record
      effect: destructive
      questions:
      - Can I delete a Project, Model or Dataset record?
      - Which object records can be removed through the API?
      instructions:
      - text: Delete object {entityId}.
        slots:
          entityId: path.entityId
      - text: Remove {entityTypeName} record {entityId}.
        slots:
          entityTypeName: query.entityTypeName
          entityId: path.entityId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/entities/{entityId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update an object record
      effect: write
      questions:
      - Can I change just a few attributes on an object record?
      - Is it possible to rename a Model record?
      instructions:
      - text: Rename object {entityId} to {name}.
        slots:
          entityId: path.entityId
          name: requestBody.name
      - text: Patch attributes {attributes} on object {entityId}.
        slots:
          attributes: requestBody.attributes
          entityId: path.entityId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/entity-basic-details/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search objects for basic details
      effect: read
      questions:
      - Is there a lighter search that returns only basic details for objects?
      - Can I limit a basic-details object search to one organization?
      instructions:
      - text: Search basic details for objects of type {entityTypeId}.
        slots:
          entityTypeId: query.entityTypeId
      - text: Find basic object details of type {entityTypeId} matching {criteria}.
        slots:
          entityTypeId: query.entityTypeId
          criteria: requestBody.criteria
      method: generated
      generated: '2026-10-02'