Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conga Export API

4 actions 4 updates phrasing extends openapi/conga-export-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['/api/cart/v1/carts/{cartId}/export'].post
$.paths['/api/clm/v1/objects/export/{fileName}/{format}'].post
$.paths['/api/clm/v1/objects/multiple/export/{fileName}/{format}'].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 Export API
  version: 1.0.0
extends: openapi/conga-export-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['/api/cart/v1/carts/{cartId}/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export cart line items to CSV
      effect: write
      questions:
      - Can I download a cart's line items as a CSV file?
      - Is it possible to export only certain line numbers from a cart?
      instructions:
      - text: Export the line items of cart {cart} to CSV.
        slots:
          cart: path.cartId
      - text: Export lines {lines} from cart {cart}.
        slots:
          lines: requestBody.lineNumbers
          cart: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/objects/export/{fileName}/{format}'].post
  update:
    x-apievangelist-phrasing:
      intent: Export CLM query results to a file
      effect: write
      questions:
      - How do I export a CLM object query to Excel?
      - Can I export records matching criteria as CSV?
      instructions:
      - text: Export {object} records matching {criteria} to {file} in {format}.
        slots:
          object: requestBody.ObjectName
          criteria: requestBody.Criteria
          file: path.fileName
          format: path.format
      - text: Export a query of {object} as file {file} with format {format}.
        slots:
          object: requestBody.ObjectName
          file: path.fileName
          format: path.format
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/objects/multiple/export/{fileName}/{format}'].post
  update:
    x-apievangelist-phrasing:
      intent: Export multi-object search results
      effect: write
      questions:
      - Can I export search results that span several object types?
      - Which endpoint exports a document text search to a spreadsheet?
      instructions:
      - text: Export search results for {text} across objects to {file} as {format}.
        slots:
          text: requestBody.DocumentSearchText
          file: path.fileName
          format: path.format
      - text: Export these multi-object queries {queries} to {file} in {format}.
        slots:
          queries: requestBody.MultipleObjectSearchQueries
          file: path.fileName
          format: path.format
      method: generated
      generated: '2026-10-01'