Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Dynamic Content API

7 actions 7 updates phrasing extends openapi/zendesk-dynamic-content-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 7

$.info

$.paths['/api/v2/dynamic_content/items'].get

$.paths['/api/v2/dynamic_content/items'].post

$.paths['/api/v2/dynamic_content/items/{dynamic_content_item_id}'].get

$.paths['/api/v2/dynamic_content/items/{dynamic_content_item_id}'].put

$.paths['/api/v2/dynamic_content/items/{dynamic_content_item_id}'].delete

$.paths['/api/v2/dynamic_content/items/show_many'].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 Dynamic Content API
  version: 1.0.0
extends: openapi/zendesk-dynamic-content-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: 6
- target: $.paths['/api/v2/dynamic_content/items'].get
  update:
    x-apievangelist-phrasing:
      intent: List dynamic content items
      effect: read
      questions:
      - What dynamic content items exist in my account?
      - Who can list dynamic content?
      instructions:
      - text: List all dynamic content items.
      - text: Show every dynamic content placeholder we have.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/dynamic_content/items'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a dynamic content item
      effect: write
      questions:
      - Can I create a dynamic content item with translations?
      - Do I need a default locale when creating dynamic content?
      instructions:
      - text: Create a dynamic content item with an English default variant.
      - text: Add a new dynamic content placeholder with these variants.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/dynamic_content/items/{dynamic_content_item_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dynamic content item
      effect: read
      questions:
      - How do I see one dynamic content item and its placeholder?
      - Can I look up a dynamic content item by id?
      instructions:
      - text: Show this dynamic content item.
      - text: Get one dynamic content item's details.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/dynamic_content/items/{dynamic_content_item_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a dynamic content item
      effect: write
      questions:
      - Can I rename a dynamic content item?
      - What can I change on a dynamic content item itself?
      instructions:
      - text: Rename this dynamic content item.
      - text: Change the name of one dynamic content item.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/dynamic_content/items/{dynamic_content_item_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a dynamic content item
      effect: destructive
      questions:
      - Can I delete a dynamic content item I no longer use?
      - Is removing a dynamic content item permanent?
      instructions:
      - text: Delete this dynamic content item.
      - text: Remove one dynamic content item.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/dynamic_content/items/show_many'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several dynamic content items
      effect: read
      questions:
      - Can I fetch several dynamic content items by identifier at once?
      - Is fetching many dynamic content items still in development?
      instructions:
      - text: Show the dynamic content items {identifiers}.
        slots:
          identifiers: query.identifiers
      - text: Fetch several dynamic content items by identifier.
      method: generated
      generated: '2026-09-26'