OneTrust · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/v1/entity-types/names/{entityTypeName}'].get
$.paths['/v1/entity-types/names/{entityTypeName}'].patch
$.paths['/v1/entity-types/names/{entityTypeName}/enable'].put
$.paths['/v1/entity-types/search'].post
$.paths['/v1/entity-types/{entityTypeId}'].get
$.paths['/v1/entity-types/{entityTypeId}'].patch
$.paths['/v1/entity-types/{entityTypeId}/enable'].put

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 Type Management API
  version: 1.0.0
extends: openapi/onetrust-object-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: 7
- target: $.paths['/v1/entity-types/names/{entityTypeName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an object type by name
      effect: read
      questions:
      - Who created an object type like Models, and when, looked up by its name?
      - How do I get an Object Manager object type's details using its name?
      instructions:
      - text: Show the object type named {entityTypeName}.
        slots:
          entityTypeName: path.entityTypeName
      - text: Get details for object type {entityTypeName} by name.
        slots:
          entityTypeName: path.entityTypeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/entity-types/names/{entityTypeName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Modify a custom object type by name
      effect: write
      questions:
      - How do I change the description of a custom object type when I only know its name?
      - Can I update an object type's module scopes by name?
      instructions:
      - text: Update the description of object type {entityTypeName} to {description}.
        slots:
          entityTypeName: path.entityTypeName
          description: requestBody.description
      - text: Rename object type {entityTypeName} to {name}.
        slots:
          entityTypeName: path.entityTypeName
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/entity-types/names/{entityTypeName}/enable'].put
  update:
    x-apievangelist-phrasing:
      intent: Enable a custom object type by name
      effect: write
      questions:
      - How do I turn on a custom object type using its name?
      - Can I enable an Object Manager type like Datasets by name?
      instructions:
      - text: Enable the object type named {entityTypeName}.
        slots:
          entityTypeName: path.entityTypeName
      - text: Turn on custom object type {entityTypeName} by name.
        slots:
          entityTypeName: path.entityTypeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/entity-types/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search object types
      effect: read
      questions:
      - What object types exist in Object Manager?
      - Can I search object types by keyword and filters?
      instructions:
      - text: List all object types.
      - text: Search object types for {fullText}.
        slots:
          fullText: requestBody.fullText
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/entity-types/{entityTypeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an object type by ID
      effect: read
      questions:
      - How do I look up an object type using its unique ID?
      - What created date and description does a given object type ID have?
      instructions:
      - text: Show object type {entityTypeId}.
        slots:
          entityTypeId: path.entityTypeId
      - text: Get details for object type ID {entityTypeId}.
        slots:
          entityTypeId: path.entityTypeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/entity-types/{entityTypeId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Modify a custom object type by ID
      effect: write
      questions:
      - How do I update a custom object type's settings using its ID?
      - Can I change the workflow of an object type identified by ID?
      instructions:
      - text: Update object type ID {entityTypeId} with description {description}.
        slots:
          entityTypeId: path.entityTypeId
          description: requestBody.description
      - text: Rename object type ID {entityTypeId} to {name}.
        slots:
          entityTypeId: path.entityTypeId
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/entity-types/{entityTypeId}/enable'].put
  update:
    x-apievangelist-phrasing:
      intent: Enable a custom object type by ID
      effect: write
      questions:
      - How do I enable a custom object type using its ID?
      - Can I activate an object type when I have its unique identifier?
      instructions:
      - text: Enable object type ID {entityTypeId}.
        slots:
          entityTypeId: path.entityTypeId
      - text: Turn on custom object type with ID {entityTypeId}.
        slots:
          entityTypeId: path.entityTypeId
      method: generated
      generated: '2026-09-26'