Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Ticket Skips API

3 actions 3 updates phrasing extends openapi/zendesk-ticket-skips-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 3

$.info
$.paths['/api/v2/skips'].post
$.paths['/api/v2/users/{user_id}/skips'].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 Zendesk Ticket Skips API
  version: 1.0.0
extends: openapi/zendesk-ticket-skips-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: 2
- target: $.paths['/api/v2/skips'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a ticket skip
      effect: write
      questions:
      - Can I record that I skipped a ticket?
      - Is a skip recorded for the current user?
      instructions:
      - text: Record a skip for this ticket.
      - text: Log that I skipped the ticket with a reason.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/users/{user_id}/skips'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's ticket skips
      effect: read
      questions:
      - Which tickets has an agent skipped?
      - Are archived tickets included in skip lists?
      instructions:
      - text: List ticket skips for this user.
      - text: Show which tickets one agent skipped.
      method: generated
      generated: '2026-09-26'