API Evangelist conversational phrasing for Tech Risk & Compliance - Audit Management Workpapers API

# 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 - Audit Management Workpapers API
  version: 1.0.0
extends: openapi/onetrust-workpapers-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/audit-management/v1/audit-workpapers/pages'].post
  update:
    x-apievangelist-phrasing:
      intent: Search audit workpapers
      effect: read
      questions:
      - Which audit workpapers mention a specific control or keyword?
      - Can I filter workpapers and see their findings?
      instructions:
      - text: Search audit workpapers for {fullText}.
        slots:
          fullText: requestBody.fullText
      - text: List workpapers matching {filters}, sorted by {sort}.
        slots:
          filters: requestBody.filters
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/audit-management/v1/audit-workpapers/{workpaperId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Record results on an audit workpaper
      effect: write
      questions:
      - How do I record testing results on an audit workpaper?
      - Can I change workpaper assignees with this update?
      instructions:
      - text: Set the testing result of workpaper {workpaperId} to {testingResult}.
        slots:
          workpaperId: path.workpaperId
          testingResult: requestBody.testingResult
      - text: Record sampling result {samplingResult} and interview result {interviewResult} on workpaper {workpaperId}.
        slots:
          samplingResult: requestBody.samplingResult
          interviewResult: requestBody.interviewResult
          workpaperId: path.workpaperId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/audit-management/v1/audit-workpapers/{workpaperId}/attribute-details'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workpaper's results and attributes
      effect: read
      questions:
      - What were the testing, sampling and interview results on a workpaper?
      - Where do I read the attribute values recorded on an audit workpaper?
      instructions:
      - text: Show the results and attributes of workpaper {workpaperId}.
        slots:
          workpaperId: path.workpaperId
      - text: Get the recorded test outcomes for workpaper {workpaperId}.
        slots:
          workpaperId: path.workpaperId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/audit-management/v1/audit-workpapers/{workpaperId}/control-details'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the control details of a workpaper
      effect: read
      questions:
      - Which control is an audit workpaper testing?
      - How do I see the control information behind a workpaper?
      instructions:
      - text: Show the control details of workpaper {workpaperId}.
        slots:
          workpaperId: path.workpaperId
      - text: Tell me which control workpaper {workpaperId} covers.
        slots:
          workpaperId: path.workpaperId
      method: generated
      generated: '2026-09-26'