Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Oauth Global Clients API

4 actions 4 updates phrasing extends openapi/zendesk-global-clients-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 4

$.info

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

$.paths['/api/v2/oauth/global_clients/{global_client_id}'].get

$.paths['/api/v2/oauth/global_clients/token_summary'].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 Oauth Global Clients API
  version: 1.0.0
extends: openapi/zendesk-global-clients-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: 3
- target: $.paths['/api/v2/oauth/global_clients'].get
  update:
    x-apievangelist-phrasing:
      intent: List authorized global OAuth clients
      effect: read
      questions:
      - Which global OAuth apps have my users authorized?
      - Can I page through all global clients connected to my account?
      instructions:
      - text: List the global OAuth clients my users authorized.
      - text: Show which global apps have access to the account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/oauth/global_clients/{global_client_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a global OAuth client
      effect: read
      questions:
      - Where can I see details of one global OAuth client?
      - Is looking up a global client admin-only?
      instructions:
      - text: Show this global OAuth client.
      - text: Get details of that authorized global app.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/oauth/global_clients/token_summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize tokens for global clients
      effect: read
      questions:
      - How many tokens has each global OAuth client been issued in my account?
      - Can I see token usage across authorized global apps?
      instructions:
      - text: Summarize tokens for the global OAuth clients.
      - text: Show a token summary per authorized global app.
      method: generated
      generated: '2026-09-26'