# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Pirsch Clients API
  version: 1.0.0
extends: openapi/pirsch-clients-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/client'].get
  update:
    x-apievangelist-phrasing:
      intent: List the API clients on a domain
      effect: read
      questions:
      - Which API clients and access tokens are set up for my site?
      - Can I see every OAuth client that has access to a domain's analytics?
      instructions:
      - text: List the API clients for domain {id}.
        slots:
          id: query.id
      - text: Show all OAuth and access-token clients configured on domain {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/client'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API client for a domain
      effect: write
      questions:
      - How do I create an OAuth client so my server can send data to Pirsch?
      - Can I generate an access token client instead of an OAuth client for a domain?
      instructions:
      - text: Create a {type} API client for domain {domain_id} described as {description}.
        slots:
          type: requestBody.type
          domain_id: requestBody.domain_id
          description: requestBody.description
      - text: Add a new {type} client named {description} to domain {domain_id} for server-side tracking.
        slots:
          type: requestBody.type
          description: requestBody.description
          domain_id: requestBody.domain_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/client'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an API client
      effect: destructive
      questions:
      - How do I revoke an API client's access to my analytics?
      - Will deleting an API client stop requests that use its credentials?
      instructions:
      - text: Delete API client {id}.
        slots:
          id: query.id
      - text: Revoke the API client {id} so its credentials stop working.
        slots:
          id: query.id
      method: generated
      generated: '2026-10-01'