Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Sharing Agreements API

6 actions 6 updates phrasing extends openapi/zendesk-sharing-agreements-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/sharing_agreements'].get

$.paths['/api/v2/sharing_agreements'].post

$.paths['/api/v2/sharing_agreements/{sharing_agreement_id}'].get

$.paths['/api/v2/sharing_agreements/{sharing_agreement_id}'].put

$.paths['/api/v2/sharing_agreements/{sharing_agreement_id}'].delete

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 Sharing Agreements API
  version: 1.0.0
extends: openapi/zendesk-sharing-agreements-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/sharing_agreements'].get
  update:
    x-apievangelist-phrasing:
      intent: List ticket sharing agreements
      effect: read
      questions:
      - Which ticket sharing agreements does my account have with other accounts?
      - Can agents see the list of sharing agreements?
      instructions:
      - text: List all ticket sharing agreements.
      - text: Show the sharing agreements set up on my account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/sharing_agreements'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a ticket sharing agreement
      effect: write
      questions:
      - How do I set up ticket sharing with another help desk account?
      - Who can create a sharing agreement?
      instructions:
      - text: Create a new ticket sharing agreement with a partner account.
      - text: Set up an agreement to share tickets with another account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/sharing_agreements/{sharing_agreement_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a sharing agreement
      effect: read
      questions:
      - Can I view the details of a single sharing agreement?
      - What status does one ticket sharing agreement have?
      instructions:
      - text: Show the sharing agreement with that ID.
      - text: Fetch the details of one ticket sharing agreement.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/sharing_agreements/{sharing_agreement_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a sharing agreement's status
      effect: write
      questions:
      - Can I accept or decline a pending sharing agreement?
      - Which field of a sharing agreement can be updated?
      instructions:
      - text: Accept that pending sharing agreement by updating its status.
      - text: Set the status of one sharing agreement to inactive.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/sharing_agreements/{sharing_agreement_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a sharing agreement
      effect: destructive
      questions:
      - Can I end ticket sharing by deleting the agreement?
      - Who is allowed to remove a sharing agreement?
      instructions:
      - text: Delete that ticket sharing agreement.
      - text: Remove the sharing agreement with the partner account.
      method: generated
      generated: '2026-09-26'