API Evangelist conversational phrasing for Onetrust Personal Data API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Onetrust Personal Data API
  version: 1.0.0
extends: openapi/onetrust-personal-data-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: 18
- target: $.paths['/api/inventory/v2/data-categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List data categories
      effect: read
      questions:
      - What data categories are defined in my OneTrust data mapping inventory?
      - Can I search data categories by part of their name?
      - Which personal data categories exist, sorted alphabetically?
      instructions:
      - text: List all data categories.
      - text: Find data categories whose name contains {filter}.
        slots:
          filter: query.filter
      - text: Show page {page} of data categories with {size} per page.
        slots:
          page: query.page
          size: query.size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/data-categories'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a data category
      effect: write
      questions:
      - How do I add a new data category to data mapping automation?
      - Can I give a new data category a description when creating it?
      instructions:
      - text: Create a data category named {value}.
        slots:
          value: requestBody.value
      - text: Add a data category called {value} described as {description}.
        slots:
          value: requestBody.value
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/data-categories/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data category
      effect: read
      questions:
      - What are the details of a specific data category by its ID?
      - Where can I look up one data category's name and status?
      instructions:
      - text: Show data category {id}.
        slots:
          id: path.id
      - text: Get the details of data category {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/data-categories/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data category
      effect: destructive
      questions:
      - How do I remove a data category from my data inventory?
      - Why can't I delete a data category that still has data elements assigned?
      instructions:
      - text: Delete data category {id}.
        slots:
          id: path.id
      - text: Remove the unused data category {id} from data mapping.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/data-classifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List all data classifications
      effect: read
      questions:
      - What data classifications exist in my data mapping setup?
      - Can I get every data classification in one unpaged call under the /api path?
      instructions:
      - text: List every data classification without paging.
      - text: Pull the full set of data classifications from the /api inventory endpoint.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/data-classifications'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a data classification
      effect: write
      questions:
      - How do I add a new data classification like Confidential or Restricted?
      - Can a new data classification carry a description?
      instructions:
      - text: Create a data classification named {value}.
        slots:
          value: requestBody.value
      - text: Add a data classification {value} with the description {description}.
        slots:
          value: requestBody.value
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/data-classifications/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data classification
      effect: read
      questions:
      - How can I look up a single data classification by ID?
      - What details are stored for one data classification?
      instructions:
      - text: Show data classification {id}.
        slots:
          id: path.id
      - text: Get the details of data classification {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/data-classifications/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data classification
      effect: destructive
      questions:
      - How do I remove a data classification I no longer use?
      - Can I delete a data classification by its ID?
      instructions:
      - text: Delete data classification {id}.
        slots:
          id: path.id
      - text: Remove the data classification {id} from data mapping.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/data-elements'].get
  update:
    x-apievangelist-phrasing:
      intent: List all data elements
      effect: read
      questions:
      - What data elements are tracked in my data mapping inventory?
      - Can I fetch every data element in one unpaged request under the /api path?
      instructions:
      - text: List every data element without paging.
      - text: Pull the full set of data elements from the /api inventory endpoint.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/data-elements'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a data element
      effect: write
      questions:
      - How do I add a new data element such as email address to my inventory?
      - Can a new data element be assigned to categories and all data subjects at once?
      instructions:
      - text: Create a data element named {value} in categories {categories}.
        slots:
          value: requestBody.value
          categories: requestBody.categories
      - text: Add data element {value} under {categories} with classifications {classifications}.
        slots:
          value: requestBody.value
          categories: requestBody.categories
          classifications: requestBody.classifications
      - text: 'Create data element {value} in {categories} and assign it to all subjects: {assignToAllSubjects}.'
        slots:
          value: requestBody.value
          categories: requestBody.categories
          assignToAllSubjects: requestBody.assignToAllSubjects
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/data-elements/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data element
      effect: read
      questions:
      - How do I look up one data element by its ID?
      - Which categories and classifications does a given data element have?
      instructions:
      - text: Show data element {id}.
        slots:
          id: path.id
      - text: Get the details of data element {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/data-elements/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data element
      effect: destructive
      questions:
      - How do I remove a data element from data mapping?
      - Can I delete a data element by ID?
      instructions:
      - text: Delete data element {id}.
        slots:
          id: path.id
      - text: Remove the data element {id} from my inventory.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/data-subjects'].get
  update:
    x-apievangelist-phrasing:
      intent: List data subject types
      effect: read
      questions:
      - What data subject types like employees or customers are defined in data mapping?
      - Can I list data subjects related to a specific inventory object?
      - Is it possible to search data subject types by partial name?
      instructions:
      - text: List all data subject types in data mapping.
      - text: Find data subject types whose name contains {filter}.
        slots:
          filter: query.filter
      - text: List data subject types linked to {objectType} record {objectId}.
        slots:
          objectType: query.objectType
          objectId: query.objectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/data-subjects'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a data subject type
      effect: write
      questions:
      - How do I add a new data subject type such as contractors to data mapping?
      - Can I describe a data subject type when I create it?
      instructions:
      - text: Create a data subject type named {value}.
        slots:
          value: requestBody.value
      - text: Add data subject type {value} described as {description}.
        slots:
          value: requestBody.value
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/data-subjects/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data subject type
      effect: read
      questions:
      - How do I view one data subject type by its ID?
      - What is stored for a particular data subject type in data mapping?
      instructions:
      - text: Show data subject type {id}.
        slots:
          id: path.id
      - text: Get the details of data subject type {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/data-subjects/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data subject type
      effect: destructive
      questions:
      - How do I remove a data subject type from data mapping?
      - Can I delete a data subject type by its ID?
      instructions:
      - text: Delete data subject type {id}.
        slots:
          id: path.id
      - text: Remove the data subject type {id} from my inventory.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/inventory/v2/data-classifications'].get
  update:
    x-apievangelist-phrasing:
      intent: Page through data classifications
      effect: read
      questions:
      - How do I page through data classifications on the legacy /inventory path?
      - Which data classifications are on a given results page?
      instructions:
      - text: Get page {page} of data classifications from the legacy inventory path.
        slots:
          page: query.page
      - text: Show data classifications page {page} with {size} per page.
        slots:
          page: query.page
          size: query.size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/inventory/v2/data-elements'].get
  update:
    x-apievangelist-phrasing:
      intent: Page through data elements
      effect: read
      questions:
      - How do I page through data elements on the legacy /inventory path?
      - Which data elements appear on a given results page?
      instructions:
      - text: Get page {page} of data elements from the legacy inventory path.
        slots:
          page: query.page
      - text: Show data elements page {page} with {size} per page.
        slots:
          page: query.page
          size: query.size
      method: generated
      generated: '2026-09-26'