Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Locales API

7 actions 7 updates phrasing extends openapi/zendesk-locales-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/locales'].get
$.paths['/api/v2/locales/{locale_id}'].get
$.paths['/api/v2/locales/agent'].get
$.paths['/api/v2/locales/current'].get
$.paths['/api/v2/locales/detect_best_locale'].get
$.paths['/api/v2/locales/public'].get

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 Locales API
  version: 1.0.0
extends: openapi/zendesk-locales-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/locales'].get
  update:
    x-apievangelist-phrasing:
      intent: List the account's translation locales
      effect: read
      questions:
      - Which languages are enabled for my help desk account?
      - How can I change the locales available to my account?
      instructions:
      - text: List the translation locales enabled for my account.
      - text: Show the languages configured on the account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/locales/{locale_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a locale
      effect: read
      questions:
      - Can I get the details of one locale by its ID?
      - What information is returned for a single language locale?
      instructions:
      - text: Show the locale with that locale ID.
      - text: Fetch the details of one translation locale.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/locales/agent'].get
  update:
    x-apievangelist-phrasing:
      intent: List locales localized for agents
      effect: read
      questions:
      - In which languages can agents use the agent interface on my account?
      - Which locales are localized for agents rather than end users?
      instructions:
      - text: List the locales available to agents.
      - text: Show the agent-facing languages for my account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/locales/current'].get
  update:
    x-apievangelist-phrasing:
      intent: Show my current locale
      effect: read
      questions:
      - What language locale is set for the user making the request?
      - Can I read my own locale without knowing its ID?
      instructions:
      - text: Show my current locale.
      - text: Tell me which locale the requesting user has.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/locales/detect_best_locale'].get
  update:
    x-apievangelist-phrasing:
      intent: Detect the best locale
      effect: read
      questions:
      - Can the API pick the best matching language locale for a visitor?
      - Is there a way to detect which locale suits the current request best?
      instructions:
      - text: Detect the best locale for this request.
      - text: Work out which language to show this visitor.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/locales/public'].get
  update:
    x-apievangelist-phrasing:
      intent: List public locales available to all accounts
      effect: read
      questions:
      - Which languages are available to every account?
      - What public locales could I enable?
      instructions:
      - text: List the public locales available to all accounts.
      - text: Show every language locale I could add.
      method: generated
      generated: '2026-09-26'