API Evangelist conversational phrasing for Things Stack — Identity Server Client Access API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Things Stack — Identity Server Client Access API
  version: 1.0.0
extends: openapi/the-things-network-clientaccess-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['/clients/{client_ids.client_id}/collaborator/organization/{collaborator.organization_ids.organization_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization's rights on an OAuth client
      effect: read
      questions:
      - What rights does an organization have on my OAuth client?
      - Are pseudo-rights like _ALL expanded when I check an organization on a client?
      instructions:
      - text: Show the rights organization {organization_id} has on OAuth client {client_id}.
        slots:
          organization_id: path.collaborator.organization_ids.organization_id
          client_id: path.client_ids.client_id
      - text: Check what org {organization_id} may do on client {client_id}.
        slots:
          organization_id: path.collaborator.organization_ids.organization_id
          client_id: path.client_ids.client_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/clients/{client_ids.client_id}/collaborator/user/{collaborator.user_ids.user_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's rights on an OAuth client
      effect: read
      questions:
      - What can a specific user do on my OAuth client?
      - Can I check a single user's collaborator rights on a client?
      instructions:
      - text: Show the rights user {user_id} has on OAuth client {client_id}.
        slots:
          user_id: path.collaborator.user_ids.user_id
          client_id: path.client_ids.client_id
      - text: Check what user {user_id} may do on client {client_id}.
        slots:
          user_id: path.collaborator.user_ids.user_id
          client_id: path.client_ids.client_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/clients/{client_ids.client_id}/collaborators'].get
  update:
    x-apievangelist-phrasing:
      intent: List an OAuth client's collaborators
      effect: read
      questions:
      - Who has collaborator access to my OAuth client?
      - Can I page through the members of an OAuth client?
      instructions:
      - text: List collaborators on OAuth client {client_id}.
        slots:
          client_id: path.client_ids.client_id
      - text: Show {limit} members per page of client {client_id}.
        slots:
          limit: query.limit
          client_id: path.client_ids.client_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/clients/{client_ids.client_id}/collaborators'].put
  update:
    x-apievangelist-phrasing:
      intent: Add a collaborator or set rights on an OAuth client
      effect: write
      questions:
      - How do I give another user or organization access to manage my OAuth client?
      - Can I change a collaborator's rights on a client, or remove them by granting none?
      instructions:
      - text: Set collaborator {collaborator} with its rights on OAuth client {client_id}.
        slots:
          collaborator: requestBody.collaborator
          client_id: path.client_ids.client_id
      - text: Grant {collaborator} access to client {client_id}.
        slots:
          collaborator: requestBody.collaborator
          client_id: path.client_ids.client_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/clients/{client_ids.client_id}/collaborators/organization/{collaborator_ids.organization_ids.organization_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an organization from an OAuth client
      effect: destructive
      questions:
      - How do I remove an organization's access to my OAuth client?
      - Can I revoke one organization from a client without touching user members?
      instructions:
      - text: Remove organization {organization_id} from OAuth client {client_id}.
        slots:
          organization_id: path.collaborator_ids.organization_ids.organization_id
          client_id: path.client_ids.client_id
      - text: Revoke org {organization_id}'s membership of client {client_id}.
        slots:
          organization_id: path.collaborator_ids.organization_ids.organization_id
          client_id: path.client_ids.client_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/clients/{client_ids.client_id}/collaborators/user/{collaborator_ids.user_ids.user_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from an OAuth client
      effect: destructive
      questions:
      - How do I take away a person's access to an OAuth client?
      - Can I remove one user collaborator from a client?
      instructions:
      - text: Remove user {user_id} from OAuth client {client_id}.
        slots:
          user_id: path.collaborator_ids.user_ids.user_id
          client_id: path.client_ids.client_id
      - text: Revoke user {user_id}'s membership of client {client_id}.
        slots:
          user_id: path.collaborator_ids.user_ids.user_id
          client_id: path.client_ids.client_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/clients/{client_id}/rights'].get
  update:
    x-apievangelist-phrasing:
      intent: List my rights on an OAuth client
      effect: read
      questions:
      - What rights do my credentials give me on this OAuth client?
      - Can I check what I'm allowed to change on a client?
      instructions:
      - text: List the rights I hold on OAuth client {client_id}.
        slots:
          client_id: path.client_id
      - text: Check my permissions on client {client_id}.
        slots:
          client_id: path.client_id
      method: generated
      generated: '2026-09-26'