Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ingress Solution API

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

$.info
$.paths['/v1/Solution'].get
$.paths['/v1/Solution'].post
$.paths['/v1/Solution/languages'].get
$.paths['/v1/Solution/salesforce_contacts'].get
$.paths['/v1/Solution/snippet'].post
$.paths['/v1/Solution/{id}'].get
$.paths['/v1/Solution/{id}'].delete
$.paths['/v1/Solution/{id}'].patch

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 Ingress Solution API
  version: 1.0.0
extends: openapi/conga-solution-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: 8
- target: $.paths['/v1/Solution'].get
  update:
    x-apievangelist-phrasing:
      intent: List Composer solutions
      effect: read
      questions:
      - Which Composer solutions have I built?
      - Can I search solutions by name and page through them?
      instructions:
      - text: List my Composer solutions.
      - text: Find solutions named like {searchName}.
        slots:
          searchName: query.searchName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/Solution'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Composer solution
      effect: write
      questions:
      - How do I create a new document generation solution?
      - Can a new solution specify its environment and region?
      instructions:
      - text: Create a solution named {name}.
        slots:
          name: requestBody.name
      - text: Create solution {name} in environment {environment} and region {region}.
        slots:
          name: requestBody.name
          environment: requestBody.environment
          region: requestBody.region
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/Solution/languages'].get
  update:
    x-apievangelist-phrasing:
      intent: List code languages for a solution's deploy step
      effect: read
      questions:
      - Which programming languages can the deploy step generate code in?
      - What languages are supported for solution code snippets?
      instructions:
      - text: List languages available for the solution deploy step.
      - text: Show the supported snippet languages.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/Solution/salesforce_contacts'].get
  update:
    x-apievangelist-phrasing:
      intent: Search Salesforce contacts
      effect: read
      questions:
      - Can I look up Salesforce contacts while configuring a solution?
      - Which Salesforce contacts match a name in a given environment?
      instructions:
      - text: Search Salesforce contacts for {search}.
        slots:
          search: query.search
      - text: Find Salesforce contacts matching {search} in {environment}.
        slots:
          search: query.search
          environment: query.environment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/Solution/snippet'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a code snippet for a solution
      effect: read
      questions:
      - Can I get ready-to-use code that calls my solution?
      - What would the integration snippet look like in a given language?
      instructions:
      - text: Generate a {language} code snippet for solution {solution}.
        slots:
          language: requestBody.language
          solution: requestBody.solution
      - text: Get the snippet for {solution} using base URL {baseUrl}.
        slots:
          solution: requestBody.solution
          baseUrl: requestBody.baseUrl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/Solution/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Composer solution
      effect: read
      questions:
      - What templates and delivery options does a solution use?
      - Can I retrieve one solution by its ID?
      instructions:
      - text: Show solution {id}.
        slots:
          id: path.id
      - text: Fetch the full details of solution {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/Solution/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Composer solution
      effect: destructive
      questions:
      - Can I permanently remove a solution I no longer use?
      - What call deletes a solution by ID?
      instructions:
      - text: Delete solution {id}.
        slots:
          id: path.id
      - text: Remove the solution with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/Solution/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a Composer solution
      effect: write
      questions:
      - Can I change just one field, like the status, on a solution?
      - Is it possible to rename an existing solution without resending everything?
      instructions:
      - text: Rename solution {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set the status of solution {id} to {status}.
        slots:
          id: path.id
          status: requestBody.status
      method: generated
      generated: '2026-10-01'