# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Clerk Backend OAuth Applications API
  version: 1.0.0
extends: openapi/clerk-com-oauth-applications-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: 7
- target: $.paths['/oauth_applications'].get
  update:
    x-apievangelist-phrasing:
      intent: List OAuth applications
      effect: read
      questions:
      - What OAuth applications are registered in my instance?
      - Can I search my OAuth applications by name?
      instructions:
      - text: List all OAuth applications in this instance.
      - text: Find OAuth applications whose name matches {name_query}.
        slots:
          name_query: query.name_query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oauth_applications'].post
  update:
    x-apievangelist-phrasing:
      intent: Register an OAuth application
      effect: write
      questions:
      - How do I register an OAuth client so another app can sign in with my users?
      - Can I require PKCE or make an OAuth application public?
      - Which callback URL schemes are allowed for OAuth applications?
      instructions:
      - text: Create an OAuth application named {name} with redirect URIs {redirect_uris}.
        slots:
          name: requestBody.name
          redirect_uris: requestBody.redirect_uris
      - text: Register OAuth app {name} with scopes {scopes} and PKCE required set to {pkce_required}.
        slots:
          name: requestBody.name
          scopes: requestBody.scopes
          pkce_required: requestBody.pkce_required
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oauth_applications/{oauth_application_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an OAuth application
      effect: read
      questions:
      - How do I look up the settings of one OAuth application by its ID?
      - What redirect URIs and scopes does a given OAuth app have?
      instructions:
      - text: Get OAuth application {oauth_application_id}.
        slots:
          oauth_application_id: path.oauth_application_id
      - text: Show the redirect URIs and scopes of OAuth app {oauth_application_id}.
        slots:
          oauth_application_id: path.oauth_application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oauth_applications/{oauth_application_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an OAuth application
      effect: destructive
      questions:
      - How do I permanently delete an OAuth application?
      - Is deleting an OAuth app reversible?
      instructions:
      - text: Delete OAuth application {oauth_application_id}.
        slots:
          oauth_application_id: path.oauth_application_id
      - text: Permanently remove the OAuth client {oauth_application_id}.
        slots:
          oauth_application_id: path.oauth_application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oauth_applications/{oauth_application_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an OAuth application
      effect: write
      questions:
      - How do I add a redirect URI to an existing OAuth application?
      - Can I turn on the consent screen for an OAuth app I already registered?
      instructions:
      - text: Set the redirect URIs of OAuth app {oauth_application_id} to {redirect_uris}.
        slots:
          oauth_application_id: path.oauth_application_id
          redirect_uris: requestBody.redirect_uris
      - text: Rename OAuth application {oauth_application_id} to {name}.
        slots:
          oauth_application_id: path.oauth_application_id
          name: requestBody.name
      - text: Change the scopes of existing OAuth app {oauth_application_id} to {scopes}.
        slots:
          oauth_application_id: path.oauth_application_id
          scopes: requestBody.scopes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oauth_applications/{oauth_application_id}/logo'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload an OAuth application's logo
      effect: write
      questions:
      - How do I add a logo that shows on an OAuth application's consent screen?
      - What image types and sizes are accepted for OAuth app logos?
      instructions:
      - text: Upload {file} as the logo of OAuth application {oauth_application_id}.
        slots:
          file: requestBody.file
          oauth_application_id: path.oauth_application_id
      - text: Replace the OAuth app {oauth_application_id} logo with {file}.
        slots:
          oauth_application_id: path.oauth_application_id
          file: requestBody.file
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oauth_applications/{oauth_application_id}/rotate_secret'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate an OAuth application's client secret
      effect: destructive
      questions:
      - How do I rotate the client secret of an OAuth application after a leak?
      - Do authorized clients need updating after a secret rotation?
      instructions:
      - text: Rotate the client secret of OAuth application {oauth_application_id}.
        slots:
          oauth_application_id: path.oauth_application_id
      - text: Generate a new client secret for OAuth app {oauth_application_id}.
        slots:
          oauth_application_id: path.oauth_application_id
      method: generated
      generated: '2026-09-26'