API Evangelist conversational phrasing for Zendesk Views API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Zendesk Views API
  version: 1.0.0
extends: openapi/zendesk-views-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: 19
- target: $.paths['/api/v2/views/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search views by title
      effect: read
      questions:
      - Can I find a Zendesk view by searching its title?
      - Which views match a keyword, filtered to shared or personal ones?
      instructions:
      - text: Search views with titles matching {query}.
        slots:
          query: query.query
      - text: Find views where active is {active} matching {query} for group {group_id}.
        slots:
          query: query.query
          active: query.active
          group_id: query.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/views/{view_id}/tickets'].get
  update:
    x-apievangelist-phrasing:
      intent: List the tickets in a view
      effect: read
      questions:
      - Which tickets are currently sitting in a particular view?
      - Can I sort the tickets returned from a view?
      instructions:
      - text: List the tickets in this view.
      - text: Show the tickets in this view sorted by {sort_by}.
        slots:
          sort_by: query.sort_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/views'].get
  update:
    x-apievangelist-phrasing:
      intent: List views
      effect: read
      questions:
      - How do I get all shared and personal views I can use?
      - Can I list only the views that belong to one group?
      instructions:
      - text: List all views available to me.
      - text: List views with {access} access for group {group_id}.
        slots:
          access: query.access
          group_id: query.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/views'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a view
      effect: write
      questions:
      - Can I create a new ticket view with my own conditions?
      - What conditions must a new view include?
      instructions:
      - text: Create a view showing all open urgent tickets.
      - text: Add a new shared view for unassigned tickets.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/views/{view_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a view
      effect: read
      questions:
      - Where can I see the conditions and columns of one view?
      - How do I look up a single view by id?
      instructions:
      - text: Show the definition of this view.
      - text: Get the conditions and output settings of one view.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/views/{view_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a view
      effect: write
      questions:
      - Can I change the conditions of an existing view?
      - Does updating one condition of a view replace the whole conditions list?
      instructions:
      - text: Update this view to also include pending tickets.
      - text: Rename an existing view and change its columns.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/views/{view_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a view
      effect: destructive
      questions:
      - Can I delete a single view I no longer need?
      - Is removing one view permanent?
      instructions:
      - text: Delete this view.
      - text: Remove the old view from the account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/views/{view_id}/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count tickets in one view
      effect: read
      questions:
      - How many tickets are in a specific view right now?
      - What's the rate limit on counting tickets in a single view?
      instructions:
      - text: Count the tickets in this view.
      - text: Tell me how many tickets are in one view.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/views/{view_id}/execute'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a view and get its rows
      effect: read
      questions:
      - Can I get a view's column titles and row values like the agent UI shows?
      - What does executing a view return compared with listing its tickets?
      instructions:
      - text: Execute this view and return its columns and rows.
      - text: Run the view and give me the rows sorted by {sort_by} {sort_order}.
        slots:
          sort_by: query.sort_by
          sort_order: query.sort_order
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/views/{view_id}/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a view as CSV
      effect: read
      questions:
      - Can I download a view's tickets as a CSV file?
      - What happens if a view's CSV export isn't ready yet?
      instructions:
      - text: Export this view to CSV.
      - text: Get the CSV attachment for one view.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/views/active'].get
  update:
    x-apievangelist-phrasing:
      intent: List active views
      effect: read
      questions:
      - Which views are currently active for me?
      - Can I list only active views for one group?
      instructions:
      - text: List my active views.
      - text: Show active views for group {group_id}.
        slots:
          group_id: query.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/views/compact'].get
  update:
    x-apievangelist-phrasing:
      intent: List views in compact form
      effect: read
      questions:
      - Is there a lightweight list of views, like the sidebar shows?
      - What's the maximum number of views the compact list returns?
      instructions:
      - text: Give me the compact list of views.
      - text: Show the short compacted view list, up to 32 records.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/views/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count the views in the account
      effect: read
      questions:
      - How many views do I have available in total?
      - Is the total number of views an approximate count?
      instructions:
      - text: Count how many views I have.
      - text: Tell me the approximate total number of views.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/views/count_many'].get
  update:
    x-apievangelist-phrasing:
      intent: Count tickets in several views
      effect: read
      questions:
      - Can I get ticket counts for many views in one request?
      - How many view ids can I pass when counting tickets across views?
      instructions:
      - text: Get the ticket counts for views {ids}.
        slots:
          ids: query.ids
      - text: 'Count tickets in each of these views: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/views/destroy_many'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several views at once
      effect: destructive
      questions:
      - Can I bulk delete a list of views?
      - How do I remove many views by id in one call?
      instructions:
      - text: Delete the views {ids}.
        slots:
          ids: query.ids
      - text: 'Bulk remove these views: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/views/preview'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview a view's tickets before saving
      effect: read
      questions:
      - Can I test view conditions and see matching tickets before creating the view?
      - What tickets would an unsaved view return?
      instructions:
      - text: Preview the tickets these view conditions would match.
      - text: Try out a draft view without saving it.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/views/preview/count'].post
  update:
    x-apievangelist-phrasing:
      intent: Count tickets in an unsaved view preview
      effect: read
      questions:
      - How many tickets would a draft view match?
      - Can I get just a ticket count for a view preview?
      instructions:
      - text: Count tickets that match these draft view conditions.
      - text: Tell me how many tickets a preview view would return.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/views/show_many'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several views by id
      effect: read
      questions:
      - Can I fetch a specific set of views by their ids?
      - Is there a way to retrieve many views at once and filter by active?
      instructions:
      - text: Show the views {ids}.
        slots:
          ids: query.ids
      - text: Fetch views {ids}, filtered to active = {active}.
        slots:
          ids: query.ids
          active: query.active
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/views/update_many'].put
  update:
    x-apievangelist-phrasing:
      intent: Update several views at once
      effect: write
      questions:
      - Can I reorder or deactivate multiple views in one call?
      - Which properties can a bulk view update change?
      instructions:
      - text: Bulk update the position of these views.
      - text: Deactivate several views in one request.
      method: generated
      generated: '2026-09-26'