Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Search API

4 actions 4 updates phrasing extends openapi/zendesk-search-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/search'].get

$.paths['/api/v2/search/count'].get

$.paths['/api/v2/search/export'].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 Search API
  version: 1.0.0
extends: openapi/zendesk-search-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/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search tickets, users and more
      effect: read
      questions:
      - How do I search across tickets, users and organizations?
      - Can I sort search results by priority or status?
      instructions:
      - text: Search for {query}.
        slots:
          query: query.query
      - text: Search {query} sorted by {sort_by} {sort_order}.
        slots:
          query: query.query
          sort_by: query.sort_by
          sort_order: query.sort_order
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/search/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count search results
      effect: read
      questions:
      - How many items match a search without fetching them?
      - Can I get just the count for a search query?
      instructions:
      - text: Count results matching {query}.
        slots:
          query: query.query
      - text: Tell me how many items match {query}.
        slots:
          query: query.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/search/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export large search results
      effect: read
      questions:
      - What if my search returns more than 1000 results?
      - Can I export search results of one type using cursor pagination?
      instructions:
      - text: Export all {type} results for {query}.
        slots:
          type: query.filter[type]
          query: query.query
      - text: Export search results for {query}, {size} per page.
        slots:
          query: query.query
          size: query.page[size]
      method: generated
      generated: '2026-09-26'