OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Platform - Integrations Workflows V2 API

3 actions 3 updates phrasing extends openapi/onetrust-workflows-v2-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 3

$.info
$.paths['/v2/workflows/export'].get
$.paths['/v2/workflows/import'].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 Platform - Integrations Workflows V2 API
  version: 1.0.0
extends: openapi/onetrust-workflows-v2-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: 2
- target: $.paths['/v2/workflows/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export an integration workflow as JSON
      effect: read
      questions:
      - How do I back up an integration workflow to a JSON file?
      - Can I export a workflow to move it to another environment?
      instructions:
      - text: Export integration workflow {workflowName} as JSON.
        slots:
          workflowName: query.workflowName
      - text: Download the JSON definition of workflow {workflowName}.
        slots:
          workflowName: query.workflowName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/workflows/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import an integration workflow from JSON
      effect: write
      questions:
      - How do I load an integration workflow from a JSON file?
      - Can I give an imported workflow a new name?
      instructions:
      - text: Import the integration workflow in {file}.
        slots:
          file: requestBody.file
      - text: Import workflow file {file} under the name {name}.
        slots:
          file: requestBody.file
          name: query.name
      method: generated
      generated: '2026-09-26'