OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for AI Governance - AI Governance Entity Management API

7 actions 7 updates phrasing extends openapi/onetrust-entity-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/ai-governance/v1/entities'].post
$.paths['/api/ai-governance/v1/entities/search'].post
$.paths['/api/ai-governance/v1/entities/{entityId}'].get
$.paths['/api/ai-governance/v1/entities/{entityId}'].delete
$.paths['/api/ai-governance/v1/entities/{entityId}'].patch
$.paths['/api/ai-governance/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 AI Governance - AI Governance Entity Management API
  version: 1.0.0
extends: openapi/onetrust-entity-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/ai-governance/v1/entities'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an AI governance entity
      effect: write
      questions:
      - How do I register a new AI model or dataset in AI Governance?
      - Can I link a new AI system to other entities when I create it?
      instructions:
      - text: Create a {entityTypeName} entity named {name}.
        slots:
          entityTypeName: query.entityTypeName
          name: requestBody.name
      - text: Register AI agent {name} under organization {organization}.
        slots:
          name: requestBody.name
          organization: requestBody.organization
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ai-governance/v1/entities/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search AI entities with full details
      effect: read
      questions:
      - How do I get every attribute of AI models matching a query?
      - Can I choose which fields come back when searching AI governance entities in full?
      instructions:
      - text: Search {entityTypeName} entities with full details using {queryRequest}.
        slots:
          entityTypeName: query.entityTypeName
          queryRequest: requestBody.queryRequest
      - text: Return fields {requestedFields} for all {entityTypeName} records.
        slots:
          requestedFields: requestBody.requestedFields
          entityTypeName: query.entityTypeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ai-governance/v1/entities/{entityId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an AI governance entity
      effect: read
      questions:
      - What attributes and module does a specific AI model record have?
      - How do I fetch one AI system entity by its ID?
      instructions:
      - text: Show AI governance entity {entityId}.
        slots:
          entityId: path.entityId
      - text: Get {entityTypeName} entity {entityId}.
        slots:
          entityTypeName: query.entityTypeName
          entityId: path.entityId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ai-governance/v1/entities/{entityId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an AI governance entity
      effect: destructive
      questions:
      - How do I delete an AI model or dataset record?
      - Can I remove an AI agent entity by ID?
      instructions:
      - text: Delete AI governance entity {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['/api/ai-governance/v1/entities/{entityId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Modify an AI governance entity
      effect: write
      questions:
      - How do I rename an AI model record or change its attributes?
      - Can I move an AI system entity to a different organization?
      instructions:
      - text: Rename AI entity {entityId} to {name}.
        slots:
          entityId: path.entityId
          name: requestBody.name
      - text: Update the attributes of AI entity {entityId} with {attributes}.
        slots:
          entityId: path.entityId
          attributes: requestBody.attributes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ai-governance/v1/entity-basic-details/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search AI entities with basic details
      effect: read
      questions:
      - Can I get a lightweight list of AI governance entities matching criteria?
      - Is it possible to include child organizations when searching basic entity details?
      instructions:
      - text: List basic details of AI entities matching {criteria}.
        slots:
          criteria: requestBody.criteria
      - text: Get basic AI entity details for organization {requestedOrganizationId}.
        slots:
          requestedOrganizationId: requestBody.requestedOrganizationId
      method: generated
      generated: '2026-09-26'