Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Deletion Schedules API

6 actions 6 updates phrasing extends openapi/zendesk-deletion-schedules-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/deletion_schedules'].get
$.paths['/api/v2/deletion_schedules'].post
$.paths['/api/v2/deletion_schedules/{deletion_schedule_id}'].get
$.paths['/api/v2/deletion_schedules/{deletion_schedule_id}'].put
$.paths['/api/v2/deletion_schedules/{deletion_schedule_id}'].delete

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 Deletion Schedules API
  version: 1.0.0
extends: openapi/zendesk-deletion-schedules-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/deletion_schedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List deletion schedules
      effect: read
      questions:
      - Which deletion schedules are set up to purge data automatically?
      - Can I see all my data deletion schedules?
      instructions:
      - text: List all deletion schedules.
      - text: Show every automatic data deletion schedule.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/deletion_schedules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a deletion schedule
      effect: write
      questions:
      - Can I set up automatic deletion of old data?
      - Who can create a deletion schedule?
      instructions:
      - text: Create a deletion schedule from {deletion_schedule}.
        slots:
          deletion_schedule: requestBody.deletion_schedule
      - text: Set up a new schedule to auto-delete closed tickets after a year.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/deletion_schedules/{deletion_schedule_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deletion schedule
      effect: read
      questions:
      - How do I see the conditions of one deletion schedule?
      - Can I look up a deletion schedule by id?
      instructions:
      - text: Show this deletion schedule.
      - text: Get one deletion schedule's conditions.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/deletion_schedules/{deletion_schedule_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a deletion schedule
      effect: write
      questions:
      - Can I change the conditions of an existing deletion schedule?
      - Does updating a condition clear the existing conditions?
      instructions:
      - text: Update this deletion schedule with {deletion_schedule}.
        slots:
          deletion_schedule: requestBody.deletion_schedule
      - text: Change an existing deletion schedule's conditions.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/deletion_schedules/{deletion_schedule_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a deletion schedule
      effect: destructive
      questions:
      - Can I remove a deletion schedule I no longer want?
      - Is deleting a deletion schedule permanent?
      instructions:
      - text: Delete this deletion schedule.
      - text: Remove one data deletion schedule.
      method: generated
      generated: '2026-09-26'