# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Identity Platform Clients Service API
  version: 1.0.0
extends: openapi/canonical-clientsservice-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: 5
- target: $.paths['/api/v0/clients'].get
  update:
    x-apievangelist-phrasing:
      intent: List OAuth clients
      effect: read
      questions:
      - Which OAuth clients are registered in the Identity Platform?
      - Can I find OAuth clients by name or owner?
      instructions:
      - text: List all OAuth clients.
      - text: Find OAuth clients named {client_name} owned by {owner}.
        slots:
          client_name: query.client_name
          owner: query.owner
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/clients'].post
  update:
    x-apievangelist-phrasing:
      intent: Register an OAuth client
      effect: write
      questions:
      - How do I register a new OAuth client application?
      - Can I set redirect URIs and grant types when creating a client?
      - Can I let a client skip the consent screen?
      instructions:
      - text: Register OAuth client {client_name} with redirect URIs {redirect_uris}.
        slots:
          client_name: requestBody.client_name
          redirect_uris: requestBody.redirect_uris
      - text: Create client {client_name} allowing grant types {grant_types} and scope {scope}.
        slots:
          client_name: requestBody.client_name
          grant_types: requestBody.grant_types
          scope: requestBody.scope
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/clients/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an OAuth client
      effect: read
      questions:
      - What redirect URIs and grant types does a particular client have?
      - Can I look up one OAuth client by its ID?
      instructions:
      - text: Show OAuth client {id}.
        slots:
          id: path.id
      - text: Get the configuration of client {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/clients/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an OAuth client
      effect: write
      questions:
      - How do I change the redirect URIs of an existing OAuth client?
      - Can I adjust token lifespans on a client that's already registered?
      instructions:
      - text: Set redirect URIs of existing client {id} to {redirect_uris}.
        slots:
          id: path.id
          redirect_uris: requestBody.redirect_uris
      - text: Update client {id} so access tokens from the auth code grant last {lifespan}.
        slots:
          id: path.id
          lifespan: requestBody.authorization_code_grant_access_token_lifespan
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/clients/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an OAuth client
      effect: destructive
      questions:
      - How do I delete an OAuth client application?
      - Will removing a client stop it from getting new tokens?
      instructions:
      - text: Delete OAuth client {id}.
        slots:
          id: path.id
      - text: Remove client {id} from the Identity Platform.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'