OneTrust · OpenAPI Overlay 1.0.0

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

7 actions 7 updates phrasing extends openapi/onetrust-model-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['/api/custom-entity/v2/models'].post

$.paths['/api/custom-entity/v2/models/basic-details/search'].post

$.paths['/api/custom-entity/v2/models/search'].post

$.paths['/api/custom-entity/v2/models/{entityId}'].get

$.paths['/api/custom-entity/v2/models/{entityId}'].put

$.paths['/api/custom-entity/v2/models/{entityId}'].delete

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 Platform - Object Manager Model Management API
  version: 1.0.0
extends: openapi/onetrust-model-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: 6
- target: $.paths['/api/custom-entity/v2/models'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an AI model record
      effect: write
      questions:
      - How do I register a new AI model in Object Manager?
      - Can I record a model's biases and fairness metrics when creating it?
      instructions:
      - text: Create a model record named {name}.
        slots:
          name: requestBody.name
      - text: Register model {name} version {modelVersion} with known limitations {limitations}.
        slots:
          name: requestBody.name
          modelVersion: requestBody.modelVersion
          limitations: requestBody.limitations
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/custom-entity/v2/models/basic-details/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search models for basic details
      effect: read
      questions:
      - Can I get just the basic details of models matching some criteria?
      - Is there a lightweight search for model records within one organization?
      instructions:
      - text: Search models for basic details matching {criteria}.
        slots:
          criteria: requestBody.criteria
      - text: Get basic model details for organization {requestedOrganizationId}.
        slots:
          requestedOrganizationId: requestBody.requestedOrganizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/custom-entity/v2/models/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search models with full details
      effect: read
      questions:
      - Can I search model records and get every attribute back?
      - Which fields can I request when searching models in full?
      instructions:
      - text: Search models and return full details for query {queryRequest}.
        slots:
          queryRequest: requestBody.queryRequest
      - text: Find models with fields {requestedFields}.
        slots:
          requestedFields: requestBody.requestedFields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/custom-entity/v2/models/{entityId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an AI model record
      effect: read
      questions:
      - What attributes are stored on a specific model record?
      - When was a given model record created?
      instructions:
      - text: Get model {entityId}.
        slots:
          entityId: path.entityId
      - text: Show the attributes of model record {entityId}.
        slots:
          entityId: path.entityId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/custom-entity/v2/models/{entityId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Modify an AI model record
      effect: write
      questions:
      - Can I rename a model record or change its organization?
      - Is updating a model record partial?
      instructions:
      - text: Rename model {entityId} to {name}.
        slots:
          entityId: path.entityId
          name: requestBody.name
      - text: Update attributes {attributes} on model {entityId}.
        slots:
          attributes: requestBody.attributes
          entityId: path.entityId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/custom-entity/v2/models/{entityId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an AI model record
      effect: destructive
      questions:
      - Can I remove a model record from Object Manager?
      - Does deleting a model record work for models not made in Object Manager?
      instructions:
      - text: Delete model {entityId}.
        slots:
          entityId: path.entityId
      - text: Remove model record {entityId}.
        slots:
          entityId: path.entityId
      method: generated
      generated: '2026-09-26'