API Evangelist conversational phrasing for Users API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Users API
  version: 1.0.0
extends: openapi/qliksense-users-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: 8
- target: $.paths['/api/v1/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users
      effect: read
      questions:
      - Who are the users in my Qlik tenant?
      - Can I page through users and get a total count in the same call?
      instructions:
      - text: List users in my tenant.
      - text: List users matching {filter} sorted by {sort}.
        slots:
          filter: query.filter
          sort: query.sort
      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 invite someone to my tenant?
      - Can I assign roles when creating a user?
      instructions:
      - text: Invite a user with subject {subject} and email {email}.
        slots:
          subject: requestBody.subject
          email: requestBody.email
      - text: Create user {name} with subject {subject} and roles {assignedRoles}.
        slots:
          name: requestBody.name
          subject: requestBody.subject
          assignedRoles: requestBody.assignedRoles
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/users/{userId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user
      effect: read
      questions:
      - Where can I see one user's profile and roles?
      - What status does a particular user have?
      instructions:
      - text: Get user {userId}.
        slots:
          userId: path.userId
      - text: Show the profile of user {userId}.
        slots:
          userId: path.userId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/users/{userId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user
      effect: destructive
      questions:
      - How do I remove a user from my tenant?
      - Can I delete a user account permanently?
      instructions:
      - text: Delete user {userId}.
        slots:
          userId: path.userId
      - text: Remove user {userId} from the tenant.
        slots:
          userId: path.userId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/users/{userId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a user
      effect: write
      questions:
      - Can I change a user's roles or status?
      - How do I edit an existing user's details?
      instructions:
      - text: Update user {userId}.
        slots:
          userId: path.userId
      - text: Change the roles or status of user {userId}.
        slots:
          userId: path.userId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/users/actions/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count users in the tenant
      effect: read
      questions:
      - How many users does my tenant have?
      - What is the total user count?
      instructions:
      - text: Count the users in my tenant.
      - text: Tell me how many users exist.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/users/actions/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Search users with an advanced filter
      effect: read
      questions:
      - Can I search users with a complex query instead of a simple filter?
      - What is the way to find users by an advanced filter expression?
      instructions:
      - text: Find users matching the advanced filter {filter}.
        slots:
          filter: requestBody.filter
      - text: Search users with query {filter}, returning {limit} results.
        slots:
          filter: requestBody.filter
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/users/me'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my own user profile
      effect: read
      questions:
      - Who am I signed in as right now?
      - Can I fetch my own user record without knowing my user ID?
      instructions:
      - text: Show my own user profile.
      - text: Get the user record for the account I am signed in with.
      method: generated
      generated: '2026-10-01'