OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tech Risk & Compliance - Compliance Automation Initiatives…

4 actions 4 updates phrasing extends openapi/onetrust-initiatives-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 4

$.info
$.paths['/v1/initiatives/search'].post
$.paths['/v1/initiatives/{initiativeId}'].get
$.paths['/v1/initiatives/{initiativeId}'].put

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 Tech Risk & Compliance - Compliance Automation Initiatives…
  version: 1.0.0
extends: openapi/onetrust-initiatives-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: 3
- target: $.paths['/v1/initiatives/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search initiatives
      effect: read
      questions:
      - What initiatives are underway in my account?
      - Can I search initiatives by criteria?
      instructions:
      - text: List all initiatives.
      - text: Find initiatives matching {criteria}.
        slots:
          criteria: requestBody.criteria
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/initiatives/{initiativeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an initiative's details
      effect: read
      questions:
      - Which workflow stage is a given initiative in?
      - When was a particular initiative created?
      instructions:
      - text: Show initiative {initiativeId}.
        slots:
          initiativeId: path.initiativeId
      - text: Get the workflow and current stage of initiative {initiativeId}.
        slots:
          initiativeId: path.initiativeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/initiatives/{initiativeId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an initiative
      effect: write
      questions:
      - How do I change the observation window of an initiative?
      - Can I reassign an initiative's owners?
      instructions:
      - text: Set initiative {initiativeId}'s observation period from {observationStartDT} to {observationEndDT}.
        slots:
          initiativeId: path.initiativeId
          observationStartDT: requestBody.observationStartDT
          observationEndDT: requestBody.observationEndDT
      - text: Rename initiative {initiativeId} to {name} and assign owners {ownerIds}.
        slots:
          initiativeId: path.initiativeId
          name: requestBody.name
          ownerIds: requestBody.ownerIds
      method: generated
      generated: '2026-09-26'