# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Tricentis User API version: 1.0.0 extends: openapi/tricentis-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: 13 - target: $.paths['/api/v3/re-evaluation'].get update: x-apievangelist-phrasing: intent: Get my own user information effect: read questions: - Who am I logged in as in qTest? - Can I see my own username, email and name from the API? instructions: - text: Show my current user information. - text: Get my profile including apps I can't access, includeInaccessibleApps={flag}. slots: flag: query.includeInaccessibleApps method: generated generated: '2026-10-01' - target: $.paths['/api/v3/search/user'].get update: x-apievangelist-phrasing: intent: Find users by project name effect: read questions: - Which users are assigned to a project with a given name? - Can I include inactive users when searching people by project? instructions: - text: Find users assigned to project {project_name}. slots: project_name: query.projectName - text: List inactive and active members of projects named {project_name}. slots: project_name: query.projectName method: generated generated: '2026-10-01' - target: $.paths['/api/v3/users'].post update: x-apievangelist-phrasing: intent: Invite a new user effect: write questions: - How can I invite someone new to our test management instance? - What password does an invited user get if I don't set one? instructions: - text: Invite {email} as a new user with username {username}. slots: email: requestBody.email username: requestBody.username - text: Create a user {first} {last} with email {email}. slots: first: requestBody.first_name last: requestBody.last_name email: requestBody.email method: generated generated: '2026-10-01' - target: $.paths['/api/v3/users/projects'].put update: x-apievangelist-phrasing: intent: Remove users from projects effect: write questions: - Can I take several users off a project in one request? - Is it possible to unassign users without sending email notifications? instructions: - text: Remove these users from their projects. - text: Unassign the users from the projects, skipEmailNotifications={skip}. slots: skip: query.skipEmailNotifications method: generated generated: '2026-10-01' - target: $.paths['/api/v3/users/projects'].post update: x-apievangelist-phrasing: intent: Assign several users to a project effect: write questions: - How do I add a list of users to a project at once? - Can I give a batch of users a specific profile when assigning them to a project? instructions: - text: Assign users {users} to project {project}. slots: users: requestBody.user_ids project: requestBody.project_id - text: Add users {users} to project {project} with profile {profile} and no email notifications. slots: users: requestBody.user_ids project: requestBody.project_id profile: requestBody.profile method: generated generated: '2026-10-01' - target: $.paths['/api/v3/users/search'].get update: x-apievangelist-phrasing: intent: Search users by username effect: read questions: - Is there a user with this username already? - Can I search users by username and include inactive accounts? instructions: - text: Search for users with username {username}. slots: username: query.username - text: Look up user {username} including inactive users. slots: username: query.username method: generated generated: '2026-10-01' - target: $.paths['/api/v3/users/{userId}'].get update: x-apievangelist-phrasing: intent: Get a user by ID effect: read questions: - How can I retrieve one user's details by ID? - What information is returned for a single user record? instructions: - text: Get user {user}. slots: user: path.userId - text: Show the account details of user {user}. slots: user: path.userId method: generated generated: '2026-10-01' - target: $.paths['/api/v3/users/{userId}'].put update: x-apievangelist-phrasing: intent: Update a user's information effect: write questions: - Can I change a user's recovery email or reset their password? - How do I deactivate a user account by changing its status? instructions: - text: Change the email of user {user} to {email}. slots: user: path.userId email: requestBody.email - text: Set the status of user {user} to {status}. slots: user: path.userId status: requestBody.status method: generated generated: '2026-10-01' - target: $.paths['/api/v3/users/{userId}/avatar'].get update: x-apievangelist-phrasing: intent: Get a user's avatar effect: read questions: - Can I download a user's profile picture? - Where do I get the avatar image for a user? instructions: - text: Get the avatar of user {user}. slots: user: path.userId - text: Download the profile picture for user {user}. slots: user: path.userId method: generated generated: '2026-10-01' - target: $.paths['/api/v3/users/{userId}/projects'].post update: x-apievangelist-phrasing: intent: Assign one user to a project effect: write questions: - How do I add a single user to a project? - Can I choose the profile a user gets when I add them to one project? instructions: - text: Assign user {user} to project {project}. slots: user: path.userId project: requestBody.project_id - text: Add user {user} to project {project} as profile {profile}. slots: user: path.userId project: requestBody.project_id profile: requestBody.profile method: generated generated: '2026-10-01' - target: $.paths['/me'].get update: x-apievangelist-phrasing: intent: Get my Pulse account and settings effect: read questions: - Which account is my qTest Pulse session signed in as? - Can I see the settings stored on my own Pulse user? instructions: - text: Show the currently signed-in Pulse user. - text: Fetch my Pulse user record including its settings. method: generated generated: '2026-10-01' - target: $.paths['/me'].put update: x-apievangelist-phrasing: intent: Replace my Pulse user settings effect: write questions: - Can I overwrite every setting on my Pulse user in one request? - Is there a way to replace my whole Pulse settings object at once? instructions: - text: Replace my Pulse user settings with {settings}. slots: settings: requestBody.settings - text: Overwrite the signed-in Pulse user's full settings using {settings}. slots: settings: requestBody.settings method: generated generated: '2026-10-01' - target: $.paths['/me'].patch update: x-apievangelist-phrasing: intent: Partially update my Pulse user settings effect: write questions: - Can I change just one Pulse preference without resending all of my settings? - What's the way to tweak part of my Pulse user configuration? instructions: - text: Patch only {settings} on my Pulse user. slots: settings: requestBody.settings - text: Apply a partial settings change of {settings} to the signed-in Pulse account. slots: settings: requestBody.settings method: generated generated: '2026-10-01'