OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Privacy Automation - Assessment Automation Template API

5 actions 5 updates phrasing extends openapi/onetrust-template-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 5

$.info

$.paths['/api/template/v1/published-template-metadata'].get

$.paths['/api/template/v2/templates/import'].post

$.paths['/api/template/v2/templates/root-version/{rootVersionId}/templates'].delete

$.paths['/api/template/v2/templates/{templateId}/export'].get

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 Privacy Automation - Assessment Automation Template API
  version: 1.0.0
extends: openapi/onetrust-template-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: 4
- target: $.paths['/api/template/v1/published-template-metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: List published assessment templates
      effect: read
      questions:
      - Which assessment templates are published?
      - Can I list only vendor or PIA templates?
      instructions:
      - text: List all published templates.
      - text: List published templates of type {template-types}.
        slots:
          template-types: query.template-types
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/template/v2/templates/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import an assessment template
      effect: write
      questions:
      - How do I move a template from one tenant to another?
      - Can imported template attributes be matched by name?
      instructions:
      - text: 'Import the exported template, matching attributes by name: {matchAttributesByName}.'
        slots:
          matchAttributesByName: query.matchAttributesByName
      - text: Load this template JSON into the tenant with name matching set to {matchAttributesByName}.
        slots:
          matchAttributesByName: query.matchAttributesByName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/template/v2/templates/root-version/{rootVersionId}/templates'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an assessment template
      effect: destructive
      questions:
      - Can I delete a template that is not used by any assessment?
      - Which template types can't be deleted?
      instructions:
      - text: Delete template with root version {rootVersionId}.
        slots:
          rootVersionId: path.rootVersionId
      - text: Remove every version of template {rootVersionId}.
        slots:
          rootVersionId: path.rootVersionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/template/v2/templates/{templateId}/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export an assessment template
      effect: read
      questions:
      - Can I export a template's questions and metadata as JSON?
      - Is it possible to export a specific template version?
      instructions:
      - text: Export template {templateId}.
        slots:
          templateId: path.templateId
      - text: Export version {templateVersion} of template {templateId}.
        slots:
          templateVersion: query.templateVersion
          templateId: path.templateId
      method: generated
      generated: '2026-09-26'