Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ingress Merge API

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

$.info

$.paths['/v1/Merge'].post

$.paths['/v1/Merge/Preview/{correlationId}'].get

$.paths['/v1/Merge/Upload'].post

$.paths['/v1/Merge/{correlationId}/Accept'].get

$.paths['/v1/Merge/{correlationId}/Reject'].get

$.paths['/v1/Merge/{id}'].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 Ingress Merge API
  version: 1.0.0
extends: openapi/conga-merge-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: 6
- target: $.paths['/v1/Merge'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a Composer document merge
      effect: write
      questions:
      - How do I generate a document by merging data into a template with Conga Composer?
      - Can a merge pull from Salesforce data and save to a destination?
      instructions:
      - text: Start a merge using template sources {templateSources} and data {jsonData}.
        slots:
          templateSources: requestBody.templateSources
          jsonData: requestBody.jsonData
      - text: Run a merge from Salesforce request {salesforceRequest} with output {output}.
        slots:
          salesforceRequest: requestBody.salesforceRequest
          output: requestBody.output
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/Merge/Preview/{correlationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get preview and merged document URLs
      effect: read
      questions:
      - Where can I download the preview of a merged document?
      - Which merged files were produced for a correlation ID?
      instructions:
      - text: Get preview file URLs for merge {correlationId}.
        slots:
          correlationId: path.correlationId
      - text: List merged and preview documents for {correlationId}.
        slots:
          correlationId: path.correlationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/Merge/Upload'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a merge from an uploaded JSON file
      effect: write
      questions:
      - Can I upload a JSON data file and local templates to run a merge?
      - Is there a merge option where I send a file instead of a data source?
      instructions:
      - text: Upload JSON data {JsonData} and start a merge.
        slots:
          JsonData: requestBody.JsonData
      - text: Run a merge from uploaded templates {LocalTemplates} and JSON file {JsonData}.
        slots:
          LocalTemplates: requestBody.LocalTemplates
          JsonData: requestBody.JsonData
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/Merge/{correlationId}/Accept'].get
  update:
    x-apievangelist-phrasing:
      intent: Accept a previewed merge
      effect: write
      questions:
      - How do I approve a merge that is waiting in preview so post-merge actions run?
      - Can I confirm a previewed document and let delivery continue?
      instructions:
      - text: Accept the previewed merge {correlationId}.
        slots:
          correlationId: path.correlationId
      - text: Approve preview {correlationId} and continue with post-merge actions.
        slots:
          correlationId: path.correlationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/Merge/{correlationId}/Reject'].get
  update:
    x-apievangelist-phrasing:
      intent: Reject a previewed merge
      effect: destructive
      questions:
      - Can I stop a merge in preview so nothing is delivered?
      - What happens to a merge I reject during preview?
      instructions:
      - text: Reject the previewed merge {correlationId}.
        slots:
          correlationId: path.correlationId
      - text: Cancel preview {correlationId} without running post-merge actions.
        slots:
          correlationId: path.correlationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/Merge/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get merge information
      effect: read
      questions:
      - What is the status and info of a merge I started?
      - Can I look up a merge by its ID?
      instructions:
      - text: Get merge info for {id}.
        slots:
          id: path.id
      - text: Show details of merge {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'