# 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 Clients API
  version: 1.0.0
extends: openapi/zendesk-oauth-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: 6
- target: $.paths['/api/v2/oauth/clients'].get
  update:
    x-apievangelist-phrasing:
      intent: List OAuth clients
      effect: read
      questions:
      - Which OAuth clients are registered on our Zendesk account?
      - How do I page through all OAuth clients if there are more than 100?
      instructions:
      - text: List all OAuth clients registered in the account.
      - text: Show every OAuth app integration we've set up.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/oauth/clients'].post
  update:
    x-apievangelist-phrasing:
      intent: Register an OAuth client
      effect: write
      questions:
      - How do I register a new OAuth client for my integration?
      - Can I set redirect URIs when creating an OAuth client?
      instructions:
      - text: Create an OAuth client named Reporting Dashboard with our redirect URL.
      - text: Register a new OAuth client for our chat integration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/oauth/clients/{oauth_client_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an OAuth client
      effect: read
      questions:
      - How can I view one OAuth client's identifier and redirect URIs?
      - What details come back for a single OAuth client?
      instructions:
      - text: Show the Reporting Dashboard OAuth client.
      - text: Get that OAuth client's configuration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/oauth/clients/{oauth_client_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an OAuth client
      effect: write
      questions:
      - Can I change the redirect URIs on an existing OAuth client?
      - How do I rename an OAuth client?
      instructions:
      - text: Add a new redirect URI to the Reporting Dashboard OAuth client.
      - text: Update that OAuth client's name and description.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/oauth/clients/{oauth_client_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an OAuth client
      effect: destructive
      questions:
      - What happens when I delete an OAuth client that's no longer used?
      - Can admins remove an OAuth client entirely?
      instructions:
      - text: Delete the old Reporting Dashboard OAuth client.
      - text: Remove that unused OAuth client.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/oauth/clients/{oauth_client_id}/generate_secret'].put
  update:
    x-apievangelist-phrasing:
      intent: Regenerate an OAuth client secret
      effect: destructive
      questions:
      - How do I rotate the secret on an OAuth client?
      - Can I generate a new client secret if the old one leaked?
      instructions:
      - text: Generate a new secret for the Reporting Dashboard OAuth client.
      - text: Rotate that OAuth client's secret.
      method: generated
      generated: '2026-09-26'