Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Ticket Comments API

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

$.info
$.paths['/api/v2/chat_file_redactions/{ticket_id}'].put
$.paths['/api/v2/chat_redactions/{ticket_id}'].put
$.paths['/api/v2/comment_redactions/{ticket_comment_id}'].put
$.paths['/api/v2/tickets/{ticket_id}/comments'].get
$.paths['/api/v2/tickets/{ticket_id}/comments/{ticket_comment_id}/make_private'].put
$.paths['/api/v2/tickets/{ticket_id}/comments/{ticket_comment_id}/redact'].put
$.paths['/api/v2/tickets/{ticket_id}/comments/count'].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 Comments API
  version: 1.0.0
extends: openapi/zendesk-ticket-comments-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: 7
- target: $.paths['/api/v2/chat_file_redactions/{ticket_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Redact attachments from a chat ticket
      effect: destructive
      questions:
      - Can I permanently remove a file shared in a chat ticket?
      - Does chat attachment redaction work on active chats?
      instructions:
      - text: Permanently remove these chat attachments from the chat ticket.
      - text: Redact a file shared in a finished chat ticket.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/chat_redactions/{ticket_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Redact text from a chat ticket comment
      effect: destructive
      questions:
      - Can I scrub a credit card number someone typed into a chat?
      - What tags do I wrap around chat text I want redacted?
      instructions:
      - text: Redact the ID number from this chat ticket's message.
      - text: Permanently strip sensitive words from a chat comment.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/comment_redactions/{ticket_comment_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Redact content from a ticket comment
      effect: destructive
      questions:
      - Can I remove sensitive text or attachments from a comment in the Agent Workspace?
      - How does redaction with tags in the comment's HTML body work?
      instructions:
      - text: Redact the marked content from this ticket comment in the Agent Workspace.
      - text: Permanently remove an attachment and a phone number from one comment.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/tickets/{ticket_id}/comments'].get
  update:
    x-apievangelist-phrasing:
      intent: List a ticket's comments
      effect: read
      questions:
      - How do I read all the comments on a ticket?
      - Can I include inline images when listing comments?
      instructions:
      - text: List the comments on this ticket.
      - text: Show the ticket's comments with inline images set to {include_inline_images}.
        slots:
          include_inline_images: query.include_inline_images
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/tickets/{ticket_id}/comments/{ticket_comment_id}/make_private'].put
  update:
    x-apievangelist-phrasing:
      intent: Make a ticket comment private
      effect: write
      questions:
      - Can I hide a public reply so the requester can't see it?
      - Who can turn a public comment into an internal note?
      instructions:
      - text: Make this ticket comment private.
      - text: Turn one public reply into an internal note.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/tickets/{ticket_id}/comments/{ticket_comment_id}/redact'].put
  update:
    x-apievangelist-phrasing:
      intent: Redact a string from a ticket comment
      effect: destructive
      questions:
      - Can I remove a specific string like a social security number from a comment?
      - What replaces the characters when a string is redacted?
      instructions:
      - text: Redact the string 987-65-4320 from this comment.
      - text: Permanently remove one word from a ticket comment.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/tickets/{ticket_id}/comments/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count a ticket's comments
      effect: read
      questions:
      - How many comments does a ticket have?
      - Is the comment count exact or approximate?
      instructions:
      - text: Count the comments on this ticket.
      - text: Tell me how many comments are on one ticket.
      method: generated
      generated: '2026-09-26'