Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X-Author Document Sync API

4 actions 4 updates phrasing extends openapi/conga-documentsync-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/xauthor/v1/document-sync'].post

$.paths['/api/xauthor/v1/document-sync/update-document-properties'].post

$.paths['/api/xauthor/v1/document-sync/{externalId}/attachment-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 X-Author Document Sync API
  version: 1.0.0
extends: openapi/conga-documentsync-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/xauthor/v1/document-sync'].post
  update:
    x-apievangelist-phrasing:
      intent: Sync a document back to its agreement
      effect: write
      questions:
      - How do I save edits made in X-Author back to the agreement record?
      - Can I sync document content to a specific object version?
      instructions:
      - text: Sync document {documentId} content back to {objectType} {objectId} for org type {OrgType}.
        slots:
          documentId: requestBody.documentId
          objectType: requestBody.objectType
          objectId: requestBody.objectId
          OrgType: header.OrgType
      - text: Push the edited attachment {attachmentId} to object version {objectVersionId}.
        slots:
          attachmentId: requestBody.attachmentId
          objectVersionId: requestBody.objectVersionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/document-sync/update-document-properties'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a document's properties
      effect: write
      questions:
      - Can I refresh the Word document properties on an agreement file?
      - Which call updates document properties for the X-Author add-in?
      instructions:
      - text: Update the document properties for org type {OrgType}.
        slots:
          OrgType: header.OrgType
      - text: Refresh document properties using add-in load type {xaAddinLoadType}.
        slots:
          xaAddinLoadType: query.xaAddinLoadType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/document-sync/{externalId}/attachment-id'].get
  update:
    x-apievangelist-phrasing:
      intent: Find an attachment ID from an external ID
      effect: read
      questions:
      - How do I find the attachment that matches an external document ID?
      - Can I map an external file ID to its Conga attachment ID?
      instructions:
      - text: Get the attachment ID for external ID {externalId} in org type {OrgType}.
        slots:
          externalId: path.externalId
          OrgType: header.OrgType
      - text: Look up which attachment corresponds to external document {externalId}.
        slots:
          externalId: path.externalId
      method: generated
      generated: '2026-10-01'