OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tech Risk & Compliance Training API

6 actions 6 updates phrasing extends openapi/onetrust-training-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['/v1/courses'].get

$.paths['/v2/enrollments'].post

$.paths['/v1/enrollment-assignees/{enrollmentAssigneeId}/enrollment-progress'].get

$.paths['/v1/enrollments/enrollment-assignees/{enrollmentAssigneeId}'].delete

$.paths['/v1/enrollments/assignments'].post

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 Tech Risk & Compliance Training API
  version: 1.0.0
extends: openapi/onetrust-training-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['/v1/courses'].get
  update:
    x-apievangelist-phrasing:
      intent: List training courses
      effect: read
      questions:
      - What training courses are available to assign?
      - Can I search courses by keyword?
      instructions:
      - text: List courses, page {page} with {size} per page.
        slots:
          page: query.page
          size: query.size
      - text: Search courses for {searchText}, page {page}, size {size}.
        slots:
          searchText: query.searchText
          page: query.page
          size: query.size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/enrollments'].post
  update:
    x-apievangelist-phrasing:
      intent: Enroll users in a training course
      effect: write
      questions:
      - How do I assign a compliance course to a group of employees?
      - Can I set a deadline and reminders when enrolling users?
      instructions:
      - text: Enroll {users} in course {courseName} ({courseId}) by {deadline} in language {defaultLanguageName}.
        slots:
          users: requestBody.users
          courseName: requestBody.courseName
          courseId: requestBody.courseId
          deadline: requestBody.deadline
          defaultLanguageName: requestBody.defaultLanguageName
      - text: Assign course {courseId} to {users} with a {deadline} deadline.
        slots:
          courseId: requestBody.courseId
          users: requestBody.users
          deadline: requestBody.deadline
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/enrollment-assignees/{enrollmentAssigneeId}/enrollment-progress'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's course progress
      effect: read
      questions:
      - Has an employee finished their assigned course?
      - Can I check one enrollee's training progress?
      instructions:
      - text: Get enrollment progress for assignee {enrollmentAssigneeId}.
        slots:
          enrollmentAssigneeId: path.enrollmentAssigneeId
      - text: Check whether enrollee {enrollmentAssigneeId} completed their course.
        slots:
          enrollmentAssigneeId: path.enrollmentAssigneeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/enrollments/enrollment-assignees/{enrollmentAssigneeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unenroll a user from a course
      effect: destructive
      questions:
      - Can I remove someone from a course they were assigned?
      - What happens when a user is unenrolled from training?
      instructions:
      - text: Unenroll assignee {enrollmentAssigneeId}.
        slots:
          enrollmentAssigneeId: path.enrollmentAssigneeId
      - text: Remove enrollee {enrollmentAssigneeId} from their course.
        slots:
          enrollmentAssigneeId: path.enrollmentAssigneeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/enrollments/assignments'].post
  update:
    x-apievangelist-phrasing:
      intent: List course enrollment details
      effect: read
      questions:
      - Which users are enrolled in which courses?
      - Can I page through all training enrollments?
      instructions:
      - text: List enrollment details.
      - text: Show page {page} of course enrollments.
        slots:
          page: query.page
      method: generated
      generated: '2026-09-26'