OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Data Use Governance - Data Discovery Classification API

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

$.info
$.paths['/api/label-manager/v2/custom-classifiers'].get
$.paths['/api/label-manager/v2/custom-classifiers'].post
$.paths['/api/label-manager/v2/custom-classifiers/{classifierName}'].get
$.paths['/api/label-manager/v2/custom-classifiers/{classifierName}'].put
$.paths['/api/label-manager/v2/custom-classifiers/{classifierName}'].delete

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 Data Use Governance - Data Discovery Classification API
  version: 1.0.0
extends: openapi/onetrust-classification-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: 5
- target: $.paths['/api/label-manager/v2/custom-classifiers'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom data classifiers
      effect: read
      questions:
      - Which custom classifiers have we defined for data discovery?
      - Can I find classifiers mapped to a particular glossary term?
      instructions:
      - text: List all custom classifiers.
      - text: Search custom classifiers for {searchTerm}.
        slots:
          searchTerm: query.searchTerm
      - text: Show classifiers mapped to glossary term {mappedTermId}.
        slots:
          mappedTermId: query.mappedTermId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/label-manager/v2/custom-classifiers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom data classifier
      effect: write
      questions:
      - How do I teach data discovery to recognize a new kind of sensitive data?
      - Can I flag a new custom classifier as personal information?
      instructions:
      - text: Create custom classifier {name} with definition {definition}, PII flag {isPII}.
        slots:
          name: requestBody.name
          definition: requestBody.definition
          isPII: requestBody.isPII
      - text: Add a PII classifier {name} (isPII {isPII}) detecting {definition} and linked to glossary term {glossaryTerm}.
        slots:
          name: requestBody.name
          isPII: requestBody.isPII
          definition: requestBody.definition
          glossaryTerm: requestBody.glossaryTerm
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/label-manager/v2/custom-classifiers/{classifierName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom classifier by name
      effect: read
      questions:
      - What detection rules does a given custom classifier use?
      - When was a custom classifier last modified?
      instructions:
      - text: Show custom classifier {classifierName}.
        slots:
          classifierName: path.classifierName
      - text: Get the detection rules of classifier {classifierName}.
        slots:
          classifierName: path.classifierName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/label-manager/v2/custom-classifiers/{classifierName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom classifier
      effect: write
      questions:
      - How do I change the definition of an existing custom classifier?
      - Can I disable a custom classifier without deleting it?
      instructions:
      - text: 'Update classifier {classifierName}: name {name}, definition {definition}, PII {isPII}.'
        slots:
          classifierName: path.classifierName
          name: requestBody.name
          definition: requestBody.definition
          isPII: requestBody.isPII
      - text: Set enabled to {enabled} on classifier {classifierName}.
        slots:
          enabled: requestBody.enabled
          classifierName: path.classifierName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/label-manager/v2/custom-classifiers/{classifierName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom classifier
      effect: destructive
      questions:
      - How do I remove a custom classifier we no longer use?
      - Can a custom classifier be deleted by its name?
      instructions:
      - text: Delete custom classifier {classifierName}.
        slots:
          classifierName: path.classifierName
      - text: Remove the {classifierName} classifier from data discovery.
        slots:
          classifierName: path.classifierName
      method: generated
      generated: '2026-09-26'