Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Ticket Audits API

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

$.info

$.paths['/api/v2/ticket_audits'].get

$.paths['/api/v2/tickets/{ticket_id}/audits'].get

$.paths['/api/v2/tickets/{ticket_id}/audits/{ticket_audit_id}'].get

$.paths['/api/v2/tickets/{ticket_id}/audits/{ticket_audit_id}/make_private'].put

$.paths['/api/v2/tickets/{ticket_id}/audits/count'].get

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 Ticket Audits API
  version: 1.0.0
extends: openapi/zendesk-ticket-audits-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: 5
- target: $.paths['/api/v2/ticket_audits'].get
  update:
    x-apievangelist-phrasing:
      intent: List ticket audits across the account
      effect: read
      questions:
      - Can I pull the audit trail for all tickets in my account?
      - Are archived tickets included in the account-wide audit list?
      instructions:
      - text: List ticket audits across all tickets.
      - text: List account ticket audits, {page_size} per page.
        slots:
          page_size: query.page[size]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/tickets/{ticket_id}/audits'].get
  update:
    x-apievangelist-phrasing:
      intent: List the audits for one ticket
      effect: read
      questions:
      - What changes have been made to a specific ticket?
      - Can I see audits for an archived ticket?
      instructions:
      - text: List the audits for this ticket.
      - text: Show the change history of one ticket.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/tickets/{ticket_id}/audits/{ticket_audit_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a ticket audit
      effect: read
      questions:
      - How do I look up one audit on a ticket?
      - Can I see the events in a single ticket audit?
      instructions:
      - text: Show this ticket audit.
      - text: Get the events in one audit on the ticket.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/tickets/{ticket_id}/audits/{ticket_audit_id}/make_private'].put
  update:
    x-apievangelist-phrasing:
      intent: Make an audit's comment private
      effect: write
      questions:
      - Can I make a comment private using its audit id?
      - Is there a way to hide a public comment via the ticket audit?
      instructions:
      - text: Make the comment in this ticket audit private.
      - text: Hide a public reply using its audit id.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/tickets/{ticket_id}/audits/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count a ticket's audits
      effect: read
      questions:
      - How many audits does a ticket have?
      - Is the ticket audit count approximate?
      instructions:
      - text: Count the audits on this ticket.
      - text: Tell me how many audits one ticket has.
      method: generated
      generated: '2026-09-26'