Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Approvals Process Steps API

5 actions 5 updates phrasing extends openapi/conga-processsteps-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 5

$.info
$.paths['/v1/process-steps'].put
$.paths['/v1/process-steps'].post
$.paths['/v1/process-steps/validate'].get
$.paths['/v1/process-steps/{id}'].get

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 Approvals Process Steps API
  version: 1.0.0
extends: openapi/conga-processsteps-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: 4
- target: $.paths['/v1/process-steps'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an approval process step
      effect: write
      questions:
      - How do I change who approves a step in an approval process?
      - Can I turn on escalation or reminders for an existing approval step?
      instructions:
      - text: 'Update approval step {StepName}: escalation {EscalationEnabled}, reminders {ReminderEnabled}, assignee type {AssigneeType}.'
        slots:
          StepName: requestBody.StepName
          AssigneeType: requestBody.AssigneeType
          EscalationEnabled: requestBody.EscalationEnabled
          ReminderEnabled: requestBody.ReminderEnabled
      - text: Deactivate existing step {StepName} by setting active to {Active}.
        slots:
          StepName: requestBody.StepName
          Active: requestBody.Active
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/process-steps'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a step to an approval process
      effect: write
      questions:
      - How do I add a new approval step to a process?
      - What fields are required when creating an approval step?
      instructions:
      - text: Create approval step {StepName} of type {StepType} assigned to {AssigneeType}, active {Active}, escalation {EscalationEnabled}, reminders {ReminderEnabled}.
        slots:
          StepName: requestBody.StepName
          StepType: requestBody.StepType
          AssigneeType: requestBody.AssigneeType
          Active: requestBody.Active
          EscalationEnabled: requestBody.EscalationEnabled
          ReminderEnabled: requestBody.ReminderEnabled
      - text: Add a new step {StepName} to approval process {ApprovalProcessId}.
        slots:
          StepName: requestBody.StepName
          ApprovalProcessId: requestBody.ApprovalProcessId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/process-steps/validate'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a step name is unique in a process
      effect: read
      questions:
      - Is a step name already used in this approval process?
      - Can I validate a step name before creating it?
      instructions:
      - text: Check whether step name {stepName} exists in approval process {approvalProcessId}.
        slots:
          stepName: query.stepName
          approvalProcessId: query.approvalProcessId
      - text: Validate step name {stepName} for process {approvalProcessId}.
        slots:
          stepName: query.stepName
          approvalProcessId: query.approvalProcessId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/process-steps/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an approval process step
      effect: read
      questions:
      - How do I look up an approval step by its ID?
      - What assignee and criteria does a given step have?
      instructions:
      - text: Get approval process step {id}.
        slots:
          id: path.id
      - text: Show the configuration of step {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'