# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Aembit Cloud User API
  version: 1.0.0
extends: openapi/aembit-user-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['/api/v1/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users
      effect: read
      questions:
      - Who has admin access to my Aembit tenant?
      - Can I filter or group the user list?
      instructions:
      - text: List my users.
      - text: List users matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite a new user
      effect: write
      questions:
      - How do I add a new admin user to the tenant?
      - Can I assign roles when creating a user?
      instructions:
      - text: Create user {firstName} {lastName} with email {email}.
        slots:
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          email: requestBody.email
      - text: Add user {email} named {firstName} {lastName} with roles {roles}.
        slots:
          email: requestBody.email
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          roles: requestBody.roles
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user
      effect: read
      questions:
      - Is a specific user locked or using two-factor?
      - Which roles does one user have?
      instructions:
      - text: Show user {id}.
        slots:
          id: path.id
      - text: Check the roles and lock status of user {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/users/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a user's profile and roles
      effect: write
      questions:
      - How do I change a user's roles?
      - Can I update every field on a user at once?
      instructions:
      - text: Update user {id} to email {email}, name {firstName} {lastName}.
        slots:
          id: path.id
          email: requestBody.email
          firstName: requestBody.firstName
          lastName: requestBody.lastName
      - text: Replace user {id}'s roles with {roles}.
        slots:
          id: path.id
          roles: requestBody.roles
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/users/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user
      effect: destructive
      questions:
      - Can I remove a user who left the team?
      - What is the call to delete a user by ID?
      instructions:
      - text: Delete user {id}.
        slots:
          id: path.id
      - text: Remove the departed user {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/users/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a user's contact details or status
      effect: write
      questions:
      - Can I change just a user's phone number?
      - Is it possible to deactivate a user without deleting them?
      instructions:
      - text: Deactivate user {id}.
        slots:
          id: path.id
      - text: Change user {id}'s phone number to {phone}.
        slots:
          id: path.id
          phone: requestBody.phoneNumber
      - text: Change the email of user {id} to {email}.
        slots:
          id: path.id
          email: requestBody.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/users/{id}/unlock'].post
  update:
    x-apievangelist-phrasing:
      intent: Unlock a locked user
      effect: write
      questions:
      - How do I unlock a user who got locked out?
      - Can an admin unlock an account after failed sign-ins?
      instructions:
      - text: Unlock user {id}.
        slots:
          id: path.id
      - text: Restore access for locked-out user {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'