Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Approvals Adhoc Process API

7 actions 7 updates phrasing extends openapi/conga-adhocprocess-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/adhoc-process'].post

$.paths['/v1/adhoc-process/submit'].post

$.paths['/v1/adhoc-process/{objectType}/{objectId}'].get

$.paths['/v1/adhoc-process/{objectType}/{objectId}'].delete

$.paths['/v1/adhoc-process/{objectType}/{objectId}/post-submit'].get

$.paths['/v1/adhoc-process/{objectType}/{objectId}/resubmit'].post

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 Approvals Adhoc Process API
  version: 1.0.0
extends: openapi/conga-adhocprocess-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/adhoc-process'].post
  update:
    x-apievangelist-phrasing:
      intent: Define an ad hoc approval process
      effect: write
      questions:
      - How do I set up ad hoc approver groups for a record?
      - Can I require comments when someone rejects an ad hoc approval?
      instructions:
      - text: 'Save an ad hoc process with these approver groups: {AdhocGroups}.'
        slots:
          AdhocGroups: requestBody.AdhocGroups
      - text: 'Define an ad hoc process that requires comments on reject: {RequireCommentsOnReject}.'
        slots:
          RequireCommentsOnReject: requestBody.RequireCommentsOnReject
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/adhoc-process/submit'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a record for ad hoc approval
      effect: write
      questions:
      - Can I send a record for ad hoc approval with a comment and attachments?
      - What do I need to submit an ad hoc approval request?
      instructions:
      - text: Submit {ObjectType} {ObjectId} for ad hoc approval.
        slots:
          ObjectType: requestBody.ObjectType
          ObjectId: requestBody.ObjectId
      - text: Submit ad hoc approval for {ObjectType} {ObjectId} with comment {Comments}.
        slots:
          ObjectType: requestBody.ObjectType
          ObjectId: requestBody.ObjectId
          Comments: requestBody.Comments
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/adhoc-process/{objectType}/{objectId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a saved, unsubmitted ad hoc process
      effect: read
      questions:
      - What ad hoc process is saved on a record before it is submitted?
      - Can I review the draft ad hoc approvers for an object?
      instructions:
      - text: Show the saved ad hoc process for {objectType} {objectId}.
        slots:
          objectType: path.objectType
          objectId: path.objectId
      - text: Get the unsubmitted ad hoc approvers on {objectType} {objectId}.
        slots:
          objectType: path.objectType
          objectId: path.objectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/adhoc-process/{objectType}/{objectId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a record's ad hoc approvals
      effect: destructive
      questions:
      - Can I remove the ad hoc approvals from a record?
      - What call deletes an object's ad hoc process?
      instructions:
      - text: Delete the ad hoc approvals on {objectType} {objectId}.
        slots:
          objectType: path.objectType
          objectId: path.objectId
      - text: Remove the ad hoc process for {objectType} {objectId}.
        slots:
          objectType: path.objectType
          objectId: path.objectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/adhoc-process/{objectType}/{objectId}/post-submit'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a submitted ad hoc process
      effect: read
      questions:
      - What does the ad hoc process look like after it was submitted?
      - Can I check who is approving a record I already submitted ad hoc?
      instructions:
      - text: Show the submitted ad hoc process for {objectType} {objectId}.
        slots:
          objectType: path.objectType
          objectId: path.objectId
      - text: Get post-submit ad hoc details on {objectType} {objectId}.
        slots:
          objectType: path.objectType
          objectId: path.objectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/adhoc-process/{objectType}/{objectId}/resubmit'].post
  update:
    x-apievangelist-phrasing:
      intent: Resubmit an ad hoc approval
      effect: write
      questions:
      - Can I resubmit an ad hoc approval that was already submitted?
      - Is it possible to change the approver groups when resubmitting ad hoc?
      instructions:
      - text: Resubmit the ad hoc approval on {objectType} {objectId}.
        slots:
          objectType: path.objectType
          objectId: path.objectId
      - text: Resubmit {objectType} {objectId} ad hoc with approver groups {AdhocGroups}.
        slots:
          objectType: path.objectType
          objectId: path.objectId
          AdhocGroups: requestBody.AdhocGroups
      method: generated
      generated: '2026-10-01'