API Evangelist conversational phrasing for Approvals Process API

# 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 API
  version: 1.0.0
extends: openapi/conga-process-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: 19
- target: $.paths['/v1/process'].get
  update:
    x-apievangelist-phrasing:
      intent: Search approval processes for a business object
      effect: read
      questions:
      - Which approval processes are set up for agreements in Conga Approvals?
      - Can I search approval processes by name and show only the active ones?
      instructions:
      - text: Search approval processes on the {businessObjectName} object.
        slots:
          businessObjectName: query.businessObjectName
      - text: Find active approval processes on {businessObjectName} matching {filter}.
        slots:
          businessObjectName: query.businessObjectName
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/process'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an approval process
      effect: write
      questions:
      - How do I set up a new approval process with entry criteria and steps?
      - Can a new approval process name a backup admin user when it is created?
      instructions:
      - text: Create a new approval process called {Name}.
        slots:
          Name: requestBody.Name
      - text: Create approval process {Name} with {BackupAdminUser} as the backup admin.
        slots:
          Name: requestBody.Name
          BackupAdminUser: requestBody.BackupAdminUser
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/process/reorder-processes'].post
  update:
    x-apievangelist-phrasing:
      intent: Change the order approval processes run in
      effect: write
      questions:
      - Can I change the evaluation order of my approval processes?
      - What decides the new sequence when approval processes are reordered?
      instructions:
      - text: Reorder my approval processes into the sequence I give you.
      - text: Resequence the full list of approval processes so the one I name runs first.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/process/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Count a business object's active and inactive processes
      effect: read
      questions:
      - How many active versus inactive approval processes does an object have?
      - Is there a quick tally of approval processes by status for one business object?
      instructions:
      - text: Count active and inactive approval processes for {businessObjectName}.
        slots:
          businessObjectName: query.businessObjectName
      - text: Give me process stats for the {businessObjectName} object.
        slots:
          businessObjectName: query.businessObjectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/process/validate'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether an approval process name is taken
      effect: read
      questions:
      - Does an approval process with this name already exist for this object type?
      - Can I check a process name is free before creating it?
      instructions:
      - text: Check whether approval process name {approvalProcessName} exists for {businessObjectType}.
        slots:
          approvalProcessName: query.approvalProcessName
          businessObjectType: query.businessObjectType
      - text: Validate the process name {approvalProcessName} on {businessObjectType} objects.
        slots:
          approvalProcessName: query.approvalProcessName
          businessObjectType: query.businessObjectType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/process/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an approval process by ID
      effect: read
      questions:
      - What does a specific approval process look like in full?
      - Can I pull one approval process's definition by its ID?
      instructions:
      - text: Show me approval process {id}.
        slots:
          id: path.id
      - text: Fetch the full definition of approval process {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/process/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an existing approval process
      effect: write
      questions:
      - How do I rename or change the entry criteria of an existing approval process?
      - Can I change the backup admin on an approval process that already exists?
      instructions:
      - text: Rename approval process {id} to {Name}.
        slots:
          id: path.id
          Name: requestBody.Name
      - text: Set the backup admin of existing approval process {id} to {BackupAdminUser}.
        slots:
          id: path.id
          BackupAdminUser: requestBody.BackupAdminUser
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/process/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an approval process
      effect: destructive
      questions:
      - Can I permanently remove an approval process I no longer need?
      - What happens when I delete an approval process by ID?
      instructions:
      - text: Delete approval process {id}.
        slots:
          id: path.id
      - text: Remove the approval process with ID {id} entirely.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/process/{id}/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate an approval process
      effect: write
      questions:
      - How do I turn on an approval process so it starts applying?
      - Can I switch an inactive approval process back on?
      instructions:
      - text: Activate approval process {id}.
        slots:
          id: path.id
      - text: Turn on the approval process {id} so requests use it.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/process/{id}/clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy an approval process
      effect: write
      questions:
      - Can I duplicate an existing approval process as a starting point?
      - Is there a way to copy an approval process instead of rebuilding it?
      instructions:
      - text: Clone approval process {id}.
        slots:
          id: path.id
      - text: Make a copy of approval process {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/process/{id}/deactivate'].post
  update:
    x-apievangelist-phrasing:
      intent: Deactivate an approval process
      effect: write
      questions:
      - Can I temporarily switch off an approval process without deleting it?
      - What do I call to stop an approval process from applying?
      instructions:
      - text: Deactivate approval process {id}.
        slots:
          id: path.id
      - text: Turn off the approval process {id} but keep it.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/process/{id}/process-steps'].get
  update:
    x-apievangelist-phrasing:
      intent: List the steps of an approval process
      effect: read
      questions:
      - What steps make up a particular approval process?
      - Which approvers and step groups does this process run through?
      instructions:
      - text: List the steps in approval process {id}.
        slots:
          id: path.id
      - text: Show every process step configured for approval process {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/process/{id}/process-steps/{processStepId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a step in an approval process
      effect: write
      questions:
      - How do I change the assignee or step type of one approval step?
      - Can I turn on reminders or escalation for a single process step?
      instructions:
      - text: 'Update step {processStepId} of process {id}: name it {StepName}, type {StepType}, assignee type {AssigneeType}.'
        slots:
          processStepId: path.processStepId
          id: path.id
          StepName: requestBody.StepName
          StepType: requestBody.StepType
          AssigneeType: requestBody.AssigneeType
      - text: Set reminders to {ReminderEnabled} and escalation to {EscalationEnabled} on step {processStepId} in process {id}.
        slots:
          ReminderEnabled: requestBody.ReminderEnabled
          EscalationEnabled: requestBody.EscalationEnabled
          processStepId: path.processStepId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/process/{id}/process-steps/{processStepId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a step from an approval process
      effect: destructive
      questions:
      - Can I delete one step from an approval process without touching the rest?
      - What happens to a process when I remove one of its steps?
      instructions:
      - text: Delete step {processStepId} from approval process {id}.
        slots:
          processStepId: path.processStepId
          id: path.id
      - text: Remove process step {processStepId} in process {id}.
        slots:
          processStepId: path.processStepId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/process/{id}/process-steps/{processStepId}/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate a step in an approval process
      effect: write
      questions:
      - Can I re-enable a single step inside an approval process?
      - Which call turns one approval step back on?
      instructions:
      - text: Activate step {processStepId} in approval process {id}.
        slots:
          processStepId: path.processStepId
          id: path.id
      - text: Switch on process step {processStepId} of process {id}.
        slots:
          processStepId: path.processStepId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/process/{id}/process-steps/{processStepId}/deactivate'].post
  update:
    x-apievangelist-phrasing:
      intent: Deactivate a step in an approval process
      effect: write
      questions:
      - Can I skip one approval step for now without deleting it?
      - Is it possible to disable a single step of an approval process?
      instructions:
      - text: Deactivate step {processStepId} in approval process {id}.
        slots:
          processStepId: path.processStepId
          id: path.id
      - text: Switch off process step {processStepId} of process {id} but keep it.
        slots:
          processStepId: path.processStepId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/process/{id}/process-steps/{processStepId}/step-dependencies'].get
  update:
    x-apievangelist-phrasing:
      intent: List the steps a process step depends on
      effect: read
      questions:
      - Which earlier steps does this approval step depend on?
      - Can I see a step's dependencies before I delete or reorder it?
      instructions:
      - text: List the steps that step {processStepId} in process {id} depends on.
        slots:
          processStepId: path.processStepId
          id: path.id
      - text: Show dependencies of process step {processStepId} in process {id}.
        slots:
          processStepId: path.processStepId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/process/{id}/step-groups/{stepGroupId}/reorder'].post
  update:
    x-apievangelist-phrasing:
      intent: Reorder the steps within a step group
      effect: write
      questions:
      - Can I change the order of steps inside one step group of a process?
      - How do I move an approval step earlier within its group?
      instructions:
      - text: Reorder the steps in step group {stepGroupId} of process {id}.
        slots:
          stepGroupId: path.stepGroupId
          id: path.id
      - text: 'Put the steps of group {stepGroupId} in process {id} into this order: {ProcessSteps}.'
        slots:
          stepGroupId: path.stepGroupId
          id: path.id
          ProcessSteps: requestBody.ProcessSteps
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/process/{id}/unreferenced-steps'].get
  update:
    x-apievangelist-phrasing:
      intent: List steps available as dependencies
      effect: read
      questions:
      - Which steps can I still choose as a dependency for the step I'm editing?
      - What steps in a process are not yet referenced as dependencies?
      instructions:
      - text: List steps in process {id} available as dependencies.
        slots:
          id: path.id
      - text: Show which steps in process {id} step {currentStepId} could depend on.
        slots:
          id: path.id
          currentStepId: query.currentStepId
      method: generated
      generated: '2026-10-01'