# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Synadia Control Plane / Synadia Cloud App User API
  version: 1.0.0
extends: openapi/synadia-communications-app-user-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: 5
- target: $.paths['/core/beta/app-users/{appUserId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an app user
      effect: read
      questions:
      - Can I look up a platform user's profile by ID?
      - What details are stored for an app user?
      instructions:
      - text: Show app user {appUserId}.
        slots:
          appUserId: path.appUserId
      - text: Get the profile of app user {appUserId}.
        slots:
          appUserId: path.appUserId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/app-users/{appUserId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an app user
      effect: destructive
      questions:
      - Can I delete a user from the platform entirely?
      - What's the way to remove an app user account?
      instructions:
      - text: Delete app user {appUserId}.
        slots:
          appUserId: path.appUserId
      - text: Remove app user {appUserId} from the platform.
        slots:
          appUserId: path.appUserId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/app-users/{appUserId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an app user or reset their password
      effect: write
      questions:
      - Can I force a password reset for a user?
      - Is it possible to change a user's name or global role?
      instructions:
      - text: Rename app user {appUserId} to {name}.
        slots:
          appUserId: path.appUserId
          name: requestBody.name
      - text: Reset the password for app user {appUserId}.
        slots:
          appUserId: path.appUserId
      - text: Change app user {appUserId}'s role to {role_id}.
        slots:
          appUserId: path.appUserId
          role_id: requestBody.role_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/app-users/{appUserId}/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List an app user's roles
      effect: read
      questions:
      - What roles does a given user hold across teams and systems?
      - Can I see every role assigned to one app user?
      instructions:
      - text: List the roles of app user {appUserId}.
        slots:
          appUserId: path.appUserId
      - text: Show which roles {appUserId} has.
        slots:
          appUserId: path.appUserId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/app-users/{appUserId}/teams/{teamId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an existing user to a team with a role
      effect: write
      questions:
      - Can I add an existing user directly to a team without an invitation?
      - If the user is already on the team, will assigning them update the role?
      instructions:
      - text: Assign app user {appUserId} to team {teamId} as {role_id}.
        slots:
          appUserId: path.appUserId
          teamId: path.teamId
          role_id: requestBody.role_id
      - text: Put user {appUserId} on team {teamId} with role {role_id}.
        slots:
          appUserId: path.appUserId
          teamId: path.teamId
          role_id: requestBody.role_id
      method: generated
      generated: '2026-10-01'