OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Platform - Documents Attachments API

3 actions 3 updates phrasing extends openapi/onetrust-attachments-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['/api/document/v2/attachments'].post
$.paths['/api/document/v3/attachments/{attachmentId}/content'].get

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 - Documents Attachments API
  version: 1.0.0
extends: openapi/onetrust-attachments-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['/api/document/v2/attachments'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a file to attach later
      effect: write
      questions:
      - How do I upload a document so I can attach it to a record?
      - What is the maximum file size I can upload?
      instructions:
      - text: Upload {file} as attachment {attachment}.
        slots:
          file: requestBody.file
          attachment: requestBody.attachment
      - text: Upload the file {file} with attachment details {attachment} and return its ID.
        slots:
          file: requestBody.file
          attachment: requestBody.attachment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/document/v3/attachments/{attachmentId}/content'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the download URL of an uploaded file
      effect: read
      questions:
      - Where can I download a file I uploaded earlier?
      - How do I get the download link for an attachment?
      instructions:
      - text: Get the download URL for attachment {attachmentId}.
        slots:
          attachmentId: path.attachmentId
      - text: Tell me where uploaded file {attachmentId} is stored.
        slots:
          attachmentId: path.attachmentId
      method: generated
      generated: '2026-09-26'