Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conga Sign File Attachment API

10 actions 10 updates phrasing extends openapi/conga-fileattachment-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Conga's API. It is a proposal applied on top of the contract, not a document Conga publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/v1/cs-packages/{packageId}/attachment/zip'].get
$.paths['/v1/cs-packages/{packageId}/attachment/zip/{roleId}'].get
$.paths['/v1/cs-packages/{packageId}/attachment/zip/{roleId}/exists'].get
$.paths['/v1/cs-packages/{packageId}/attachment/{attachmentId}'].get
$.paths['/v1/cs-packages/{packageId}/attachment/{attachmentId}'].post
$.paths['/v1/cs-packages/{packageId}/attachment/{attachmentId}/exists'].get
$.paths['/v1/cs-packages/{packageId}/attachment/{attachmentId}/file/{fileId}'].get
$.paths['/v1/cs-packages/{packageId}/attachment/{attachmentId}/file/{fileId}'].delete
$.paths['/v1/cs-packages/{packageId}/attachment/{attachmentId}/file/{fileId}/exists'].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 Conga Sign File Attachment API
  version: 1.0.0
extends: openapi/conga-fileattachment-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: 9
- target: $.paths['/v1/cs-packages/{packageId}/attachment/zip'].get
  update:
    x-apievangelist-phrasing:
      intent: Download all of a package's attachments as a zip
      effect: read
      questions:
      - Can I download every file signers attached to a package in one zip?
      - How do I get all attachments from a signing transaction at once?
      instructions:
      - text: Download all attachments for package {packageId} as a zip.
        slots:
          packageId: path.packageId
      - text: Zip up every attachment in package {packageId}.
        slots:
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/attachment/zip/{roleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download one role's attachments as a zip
      effect: read
      questions:
      - Can I zip only the attachments uploaded by one signer role?
      - Is there a way to download attachments for a specific recipient only?
      instructions:
      - text: Download a zip of role {roleId}'s attachments in package {packageId}.
        slots:
          roleId: path.roleId
          packageId: path.packageId
      - text: Get only the files for role {roleId} from package {packageId} as one zip.
        slots:
          roleId: path.roleId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/attachment/zip/{roleId}/exists'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a role has attachments with uploads
      effect: read
      questions:
      - Has a given signer role uploaded any attachments yet?
      - Before zipping, can I check whether a role has anything to download?
      instructions:
      - text: Check whether role {roleId} in package {packageId} has any attachment uploads.
        slots:
          roleId: path.roleId
          packageId: path.packageId
      - text: Tell me if there's anything to zip for role {roleId} on package {packageId}.
        slots:
          roleId: path.roleId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/attachment/{attachmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download one attachment from a package
      effect: read
      questions:
      - How do I download a single attachment requirement's files from a package?
      - Can I fetch one attachment by its attachment ID?
      instructions:
      - text: Download attachment {attachmentId} from package {packageId}.
        slots:
          attachmentId: path.attachmentId
          packageId: path.packageId
      - text: Get the files for attachment requirement {attachmentId} on package {packageId}.
        slots:
          attachmentId: path.attachmentId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/attachment/{attachmentId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a file to a package attachment
      effect: write
      questions:
      - Can I upload a supporting document to an attachment requirement on a package?
      - What do I need to upload a file into a signing package's attachment?
      instructions:
      - text: Upload {fileName} to attachment {attachmentId} in package {packageId}.
        slots:
          fileName: requestBody.FileName
          attachmentId: path.attachmentId
          packageId: path.packageId
      - text: Add a file to attachment {attachmentId} on package {packageId}.
        slots:
          attachmentId: path.attachmentId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/attachment/{attachmentId}/exists'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if an attachment has signer uploads
      effect: read
      questions:
      - Has the signer uploaded anything for a specific attachment requirement?
      - Can I verify an attachment has signer uploads before downloading it?
      instructions:
      - text: Check whether attachment {attachmentId} in package {packageId} has signer uploads.
        slots:
          attachmentId: path.attachmentId
          packageId: path.packageId
      - text: Tell me if the signer has filled attachment {attachmentId} on package {packageId}.
        slots:
          attachmentId: path.attachmentId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/attachment/{attachmentId}/file/{fileId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a specific file within an attachment
      effect: read
      questions:
      - An attachment has several uploaded files; can I download just one of them?
      - How do I fetch a single uploaded file by its file ID?
      instructions:
      - text: Download file {fileId} from attachment {attachmentId} in package {packageId}.
        slots:
          fileId: path.fileId
          attachmentId: path.attachmentId
          packageId: path.packageId
      - text: Get uploaded file {fileId} of attachment {attachmentId} on package {packageId}.
        slots:
          fileId: path.fileId
          attachmentId: path.attachmentId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/attachment/{attachmentId}/file/{fileId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an uploaded file from an attachment
      effect: destructive
      questions:
      - Can I remove a wrong file a signer uploaded to an attachment?
      - Is deleting one file from an attachment permanent?
      instructions:
      - text: Delete file {fileId} from attachment {attachmentId} in package {packageId}.
        slots:
          fileId: path.fileId
          attachmentId: path.attachmentId
          packageId: path.packageId
      - text: Remove uploaded file {fileId} off attachment {attachmentId} on package {packageId}.
        slots:
          fileId: path.fileId
          attachmentId: path.attachmentId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/attachment/{attachmentId}/file/{fileId}/exists'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a specific attachment file exists
      effect: read
      questions:
      - Does a particular uploaded file still exist in the package's attachment?
      - Can I confirm a file ID is present before trying to download it?
      instructions:
      - text: Check whether file {fileId} exists in attachment {attachmentId} of package {packageId}.
        slots:
          fileId: path.fileId
          attachmentId: path.attachmentId
          packageId: path.packageId
      - text: Confirm uploaded file {fileId} is still on attachment {attachmentId}, package {packageId}.
        slots:
          fileId: path.fileId
          attachmentId: path.attachmentId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'