Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Clone API

4 actions 4 updates phrasing extends openapi/conga-clone-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 4

$.info

$.paths['/clone/status/{id}'].get

$.paths['/clone/{objectName}/supported-objects'].get

$.paths['/{objectName}/{objectId}/clone'].post

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 Administration Clone API
  version: 1.0.0
extends: openapi/conga-clone-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: 3
- target: $.paths['/clone/status/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a deep clone job
      effect: read
      questions:
      - Has my deep clone job in Conga finished?
      - Where can I see the progress of a running clone?
      instructions:
      - text: Check the status of deep clone job {id}.
        slots:
          id: path.id
      - text: Tell me whether clone job {id} has completed.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/clone/{objectName}/supported-objects'].get
  update:
    x-apievangelist-phrasing:
      intent: List related objects that can be cloned
      effect: read
      questions:
      - Which related records get copied along when I clone an object?
      - What child objects are cloneable for a given object type?
      instructions:
      - text: List the related cloneable objects for object type {objectName}.
        slots:
          objectName: path.objectName
      - text: Show which child records can be cloned with a {objectName}.
        slots:
          objectName: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{objectName}/{objectId}/clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone a record
      effect: write
      questions:
      - How do I duplicate an existing record in Conga?
      - Can I make a copy of an agreement or quote by its ID?
      instructions:
      - text: Clone the {objectName} record {objectId}.
        slots:
          objectName: path.objectName
          objectId: path.objectId
      - text: Make a copy of {objectName} {objectId}.
        slots:
          objectName: path.objectName
          objectId: path.objectId
      method: generated
      generated: '2026-10-01'