# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DocuSign REST Chunked Uploads API
  version: 1.0.0
extends: openapi/docusign-chunkeduploads-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/v2/accounts/{accountId}/chunked_uploads'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a chunked upload
      effect: write
      questions:
      - How do I upload a document too large to send in one request?
      - What's the first step to begin a chunked upload?
      instructions:
      - text: Start a new chunked upload in account {account} with the first chunk {data}.
        slots:
          account: path.accountId
          data: requestBody.data
      - text: Begin a chunked upload for a large file in account {account}.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/chunked_uploads/{chunkedUploadId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a chunked upload's metadata
      effect: read
      questions:
      - How can I check which parts of a chunked upload have arrived?
      - Can I see the current state of a chunked upload before committing it?
      instructions:
      - text: Get metadata for chunked upload {upload} in account {account}.
        slots:
          upload: path.chunkedUploadId
          account: path.accountId
      - text: Show the parts received so far for chunked upload {upload} on account {account}.
        slots:
          upload: path.chunkedUploadId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/chunked_uploads/{chunkedUploadId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Commit a chunked upload
      effect: write
      questions:
      - How do I finalize a chunked upload so I can use it in an envelope?
      - Does committing a chunked upload run an integrity check?
      instructions:
      - text: Commit chunked upload {upload} in account {account}.
        slots:
          upload: path.chunkedUploadId
          account: path.accountId
      - text: Run action {action} on chunked upload {upload} in account {account}.
        slots:
          action: query.action
          upload: path.chunkedUploadId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/chunked_uploads/{chunkedUploadId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a chunked upload
      effect: destructive
      questions:
      - Can I discard a chunked upload I no longer need?
      - How do I cancel an unfinished chunked upload?
      instructions:
      - text: Delete chunked upload {upload} from account {account}.
        slots:
          upload: path.chunkedUploadId
          account: path.accountId
      - text: Discard the chunked upload {upload} on account {account}.
        slots:
          upload: path.chunkedUploadId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/{chunkedUploadPartSeq}'].put
  update:
    x-apievangelist-phrasing:
      intent: Add a part to a chunked upload
      effect: write
      questions:
      - How do I add the next chunk to an in-progress upload?
      - Do chunk parts need a sequence number?
      instructions:
      - text: Add part {part} with data {data} to chunked upload {upload} in account {account}.
        slots:
          part: path.chunkedUploadPartSeq
          data: requestBody.data
          upload: path.chunkedUploadId
          account: path.accountId
      - text: Append chunk number {part} to upload {upload} on account {account}.
        slots:
          part: path.chunkedUploadPartSeq
          upload: path.chunkedUploadId
          account: path.accountId
      method: generated
      generated: '2026-10-01'