Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Approval Requests API

4 actions 4 updates phrasing extends openapi/zendesk-approval-requests-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Zendesk's API. It is a proposal applied on top of the contract, not a document Zendesk publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/api/v2/approval_workflow_instances/{approval_workflow_instance_id}/approval_requests/{approval_request_id}'].get

$.paths['/api/v2/approval_workflow_instances/{approval_workflow_instance_id}/approval_requests/{approval_request_id}/decision'].patch

$.paths['/api/v2/approval_workflow_instances/{approval_workflow_instance_id}/approval_requests/search'].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 Zendesk Approval Requests API
  version: 1.0.0
extends: openapi/zendesk-approval-requests-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/api/v2/approval_workflow_instances/{approval_workflow_instance_id}/approval_requests/{approval_request_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an approval request
      effect: read
      questions:
      - How do I view the details of an approval request assigned to me?
      - What's the current state of one approval request in a workflow?
      instructions:
      - text: Show the approval request waiting on me in that workflow.
      - text: Get the details of this approval request.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/approval_workflow_instances/{approval_workflow_instance_id}/approval_requests/{approval_request_id}/decision'].patch
  update:
    x-apievangelist-phrasing:
      intent: Approve or reject an approval request
      effect: write
      questions:
      - How do I approve or reject an approval request as the approver?
      - Can I add notes explaining my approval decision?
      instructions:
      - text: Set my decision on this approval request to {status}.
        slots:
          status: requestBody.status
      - text: Mark the approval request {status} with the note {notes}.
        slots:
          status: requestBody.status
          notes: requestBody.notes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/approval_workflow_instances/{approval_workflow_instance_id}/approval_requests/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search approvals in a workflow instance
      effect: read
      questions:
      - Which approval requests belong to one workflow instance?
      - Can I filter a workflow's approval requests by status, like pending only?
      instructions:
      - text: Search the pending approval requests in this workflow instance.
      - text: List all approvals for that workflow, filtered by status.
      method: generated
      generated: '2026-09-26'