Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conga Sign Imprint Fields API

8 actions 8 updates phrasing extends openapi/conga-imprintfields-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 8

$.info
$.paths['/v1/cs-packages/{packageId}/documents/{documentId}/imprint-fields'].put
$.paths['/v1/cs-packages/{packageId}/documents/{documentId}/imprint-fields'].post
$.paths['/v1/cs-packages/{packageId}/documents/{documentId}/imprint-fields'].delete
$.paths['/v1/cs-packages/{packageId}/documents/{documentId}/imprint-fields/{fieldId}'].get
$.paths['/v1/cs-packages/{packageId}/documents/{documentId}/imprint-fields/{fieldId}'].put
$.paths['/v1/cs-packages/{packageId}/documents/{documentId}/imprint-fields/{fieldId}'].delete
$.paths['/v1/cs-packages/{packageId}/documents/{documentId}/imprint-fields/{fieldId}/copies'].post

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 Imprint Fields API
  version: 1.0.0
extends: openapi/conga-imprintfields-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: 7
- target: $.paths['/v1/cs-packages/{packageId}/documents/{documentId}/imprint-fields'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace all imprint fields on a document
      effect: write
      questions:
      - Can I swap out every imprint field on a document in one request?
      - What happens if I send an empty list when replacing imprint fields?
      instructions:
      - text: Replace all editable imprint fields on document {documentId} in package {packageId}.
        slots:
          documentId: path.documentId
          packageId: path.packageId
      - text: Overwrite the imprint field set for package {packageId}, document {documentId} with my new list.
        slots:
          packageId: path.packageId
          documentId: path.documentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/documents/{documentId}/imprint-fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an imprint field to a document
      effect: write
      questions:
      - How do I stamp a pre-filled imprint field onto a document page?
      - Can a new imprint field be editable and carry a tooltip?
      instructions:
      - text: Add an imprint field with value {value} on page {page} of document {documentId} in package {packageId}.
        slots:
          value: requestBody.value
          page: requestBody.page
          documentId: path.documentId
          packageId: path.packageId
      - text: Create a new imprint field named {name} on document {documentId}, package {packageId}.
        slots:
          name: requestBody.name
          documentId: path.documentId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/documents/{documentId}/imprint-fields'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete all imprint fields from a document
      effect: destructive
      questions:
      - Can I clear every imprint field off a document at once?
      - Is there a single call to wipe a document's imprint fields?
      instructions:
      - text: Delete all imprint fields on document {documentId} in package {packageId}.
        slots:
          documentId: path.documentId
          packageId: path.packageId
      - text: Clear every imprint field from package {packageId}, document {documentId}.
        slots:
          packageId: path.packageId
          documentId: path.documentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/documents/{documentId}/imprint-fields/{fieldId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve one imprint field
      effect: read
      questions:
      - What value and position does a specific imprint field have?
      - Can I look up a single imprint field by its ID?
      instructions:
      - text: Get imprint field {fieldId} on document {documentId} in package {packageId}.
        slots:
          fieldId: path.fieldId
          documentId: path.documentId
          packageId: path.packageId
      - text: Show imprint field {fieldId} from package {packageId}, document {documentId}.
        slots:
          fieldId: path.fieldId
          packageId: path.packageId
          documentId: path.documentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/documents/{documentId}/imprint-fields/{fieldId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one imprint field
      effect: write
      questions:
      - How do I change the text or font size of one existing imprint field?
      - Is the ID in the body used when editing a single imprint field?
      instructions:
      - text: Set imprint field {fieldId} on document {documentId} of package {packageId} to {value}.
        slots:
          fieldId: path.fieldId
          documentId: path.documentId
          packageId: path.packageId
          value: requestBody.value
      - text: Change the font size of imprint field {fieldId} to {fontSize} in package {packageId}, document {documentId}.
        slots:
          fieldId: path.fieldId
          fontSize: requestBody.fontSize
          packageId: path.packageId
          documentId: path.documentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/documents/{documentId}/imprint-fields/{fieldId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one imprint field
      effect: destructive
      questions:
      - Can I remove just one imprint field and keep the rest?
      - How do I delete a single imprint field by ID?
      instructions:
      - text: Delete imprint field {fieldId} from document {documentId} in package {packageId}.
        slots:
          fieldId: path.fieldId
          documentId: path.documentId
          packageId: path.packageId
      - text: Remove only imprint field {fieldId} on package {packageId}, document {documentId}.
        slots:
          fieldId: path.fieldId
          packageId: path.packageId
          documentId: path.documentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/documents/{documentId}/imprint-fields/{fieldId}/copies'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy an imprint field to other documents
      effect: write
      questions:
      - Can I copy an imprint field to every other document in the package?
      - Where does a copied imprint field go if the target document has fewer pages?
      instructions:
      - text: Copy imprint field {fieldId} from document {documentId} to the other documents in package {packageId}.
        slots:
          fieldId: path.fieldId
          documentId: path.documentId
          packageId: path.packageId
      - text: Duplicate imprint field {fieldId} across package {packageId}, starting from document {documentId}.
        slots:
          fieldId: path.fieldId
          packageId: path.packageId
          documentId: path.documentId
      method: generated
      generated: '2026-10-01'