Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ingress Salesforce API

7 actions 7 updates phrasing extends openapi/conga-salesforce-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/Salesforce/Mock/relatedContacts/{recordId}'].get

$.paths['/v1/Salesforce/attachments/{objectId}'].get

$.paths['/v1/Salesforce/objectType/{recordId}'].get

$.paths['/v1/Salesforce/relatedContacts/{recordId}'].get

$.paths['/v1/Salesforce/search'].get

$.paths['/v1/Salesforce/templates'].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 Salesforce API
  version: 1.0.0
extends: openapi/conga-salesforce-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/Salesforce/Mock/relatedContacts/{recordId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get mock related contacts for testing
      effect: read
      questions:
      - Is there a mock endpoint that returns sample related contacts for a Salesforce record?
      - Can I test the related-contacts flow without real Salesforce data?
      instructions:
      - text: Return mock related contacts for record {recordId}.
        slots:
          recordId: path.recordId
      - text: Use the mock endpoint to fetch test contacts for record {recordId} in sandbox {isSandbox}.
        slots:
          recordId: path.recordId
          isSandbox: query.isSandbox
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/Salesforce/attachments/{objectId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get recent attachments on a Salesforce record
      effect: read
      questions:
      - How do I list the recent files and attachments on a Salesforce record?
      - Can I pull attachments from a sandbox org record?
      instructions:
      - text: Get recent attachments for Salesforce record {objectId}.
        slots:
          objectId: path.objectId
      - text: List files attached to record {objectId} in sandbox {isSandbox}.
        slots:
          objectId: path.objectId
          isSandbox: query.isSandbox
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/Salesforce/objectType/{recordId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Identify a Salesforce record's object type
      effect: read
      questions:
      - What type of Salesforce object is this record ID?
      - How do I get the object name for a record ID?
      instructions:
      - text: Get the object type and name for Salesforce record {recordId}.
        slots:
          recordId: path.recordId
      - text: Tell me what object record {recordId} belongs to.
        slots:
          recordId: path.recordId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/Salesforce/relatedContacts/{recordId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get real contacts related to a Salesforce record
      effect: read
      questions:
      - Which contacts are related to a given Salesforce record?
      - Can I filter a record's related contacts by name and page through them?
      instructions:
      - text: Fetch the live related contacts for Salesforce record {recordId}.
        slots:
          recordId: path.recordId
      - text: List contacts related to record {recordId} whose name matches {nameFilter}.
        slots:
          recordId: path.recordId
          nameFilter: query.nameFilter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/Salesforce/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search Salesforce leads, contacts and users
      effect: read
      questions:
      - How do I search across Salesforce leads, contacts and users by name?
      - Can I search people in a sandbox org?
      instructions:
      - text: Search Salesforce leads, contacts and users for {searchQuery}.
        slots:
          searchQuery: query.searchQuery
      - text: Find people matching {searchQuery} in sandbox {isSandbox}.
        slots:
          searchQuery: query.searchQuery
          isSandbox: query.isSandbox
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/Salesforce/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List managed package Salesforce templates
      effect: read
      questions:
      - What CET and CGT templates are in my Salesforce org's managed package?
      - Can I filter Salesforce templates by template type?
      instructions:
      - text: List Salesforce templates of type {templateType}.
        slots:
          templateType: query.templateType
      - text: Show page {page} of managed package templates with batch size {batchSize}.
        slots:
          page: query.page
          batchSize: query.batchSize
      method: generated
      generated: '2026-10-01'