Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conga Sign Signature Image API

2 actions 2 updates phrasing extends openapi/conga-signatureimage-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 2

$.info

$.paths['/v1/cs-packages/{packageId}/roles/{roleId}/signatureImage'].get

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 Conga Sign Signature Image API
  version: 1.0.0
extends: openapi/conga-signatureimage-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: 1
- target: $.paths['/v1/cs-packages/{packageId}/roles/{roleId}/signatureImage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a role's signature image in a package
      effect: read
      questions:
      - Can I download the signature a signer role used in a package?
      - Is it possible to get the signature image with a transparent background?
      instructions:
      - text: Get the signature image for role {roleId} in package {packageId}.
        slots:
          roleId: path.roleId
          packageId: path.packageId
      - text: Download role {roleId}'s {type} signature image from package {packageId} with transparency {transparent}.
        slots:
          roleId: path.roleId
          type: query.type
          packageId: path.packageId
          transparent: query.transparent
      method: generated
      generated: '2026-10-01'