Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Oauth OAuth Tokens API

5 actions 5 updates phrasing extends openapi/zendesk-oauth-tokens-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 5

$.info

$.paths['/api/v2/oauth/tokens'].get

$.paths['/api/v2/oauth/tokens'].post

$.paths['/api/v2/oauth/tokens/{oauth_token_id}'].get

$.paths['/api/v2/oauth/tokens/{oauth_token_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 Oauth OAuth Tokens API
  version: 1.0.0
extends: openapi/zendesk-oauth-tokens-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: 4
- target: $.paths['/api/v2/oauth/tokens'].get
  update:
    x-apievangelist-phrasing:
      intent: List OAuth tokens
      effect: read
      questions:
      - Which OAuth tokens have been issued for my user?
      - Can an admin see OAuth tokens for all users?
      instructions:
      - text: List my OAuth tokens.
      - text: Show all OAuth tokens in the account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/oauth/tokens'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an OAuth access token
      effect: write
      questions:
      - Can I generate an access token with a specific scope?
      - Do these OAuth access tokens expire or use refresh tokens?
      instructions:
      - text: Create an OAuth access token with read scope.
      - text: Generate a new token for our integration client.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/oauth/tokens/{oauth_token_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an OAuth token's properties
      effect: read
      questions:
      - What scopes and client does one token have?
      - Why do I only see the first 10 characters of a token?
      instructions:
      - text: Show the properties of this OAuth token.
      - text: Look up the scope of that access token.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/oauth/tokens/{oauth_token_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an OAuth token
      effect: destructive
      questions:
      - Can I revoke an access token that may be compromised?
      - Can end users revoke their own tokens?
      instructions:
      - text: Revoke this OAuth token.
      - text: Kill the leaked access token now.
      method: generated
      generated: '2026-09-26'