Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for qTest Manager API Version 3.0 User Profile API

6 actions 6 updates phrasing extends openapi/tricentis-user-profile-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Tricentis's API. It is a proposal applied on top of the contract, not a document Tricentis publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/api/v3/admin-profiles/current'].get
$.paths['/api/v3/user-profiles'].get
$.paths['/api/v3/user-profiles/batch-assign-users'].post
$.paths['/api/v3/user-profiles/current'].get
$.paths['/api/v3/user-profiles/{projectId}/batch-assign-users'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for qTest Manager API Version 3.0 User Profile API
  version: 1.0.0
extends: openapi/tricentis-user-profile-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['/api/v3/admin-profiles/current'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my admin profile
      effect: read
      questions:
      - What admin permissions do I have in qTest?
      - Which admin profile is assigned to my account?
      instructions:
      - text: Show my admin profile.
      - text: Get the admin permissions for the current user.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/user-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List available user and admin profiles
      effect: read
      questions:
      - Which permission profiles exist on our qTest instance?
      - Can I list only admin profiles or only normal user profiles?
      instructions:
      - text: List all available profiles on the site.
      - text: List profiles of type {type}.
        slots:
          type: query.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/user-profiles/batch-assign-users'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign users to a profile site-wide
      effect: write
      questions:
      - How do I give a group of users the same site-level profile?
      - Can I bulk assign an admin profile to several users?
      instructions:
      - text: Assign users {users} to profile {profile} across the site.
        slots:
          users: requestBody.userIds
          profile: requestBody.userProfileId
      - text: 'Give site profile {profile} to these users: {users}.'
        slots:
          users: requestBody.userIds
          profile: requestBody.userProfileId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/user-profiles/current'].get
  update:
    x-apievangelist-phrasing:
      intent: List my profiles across projects
      effect: read
      questions:
      - What role do I have in each project?
      - Which user profile am I assigned in my different projects?
      instructions:
      - text: Show my user profiles in every project.
      - text: List the project roles assigned to me.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/user-profiles/{projectId}/batch-assign-users'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign users to a profile in one project
      effect: write
      questions:
      - How do I change the profile of several users inside a single project?
      - Do I need to be a project admin to reassign user profiles in a project?
      instructions:
      - text: In project {project}, assign users {users} to profile {profile}.
        slots:
          project: path.projectId
          users: requestBody.userIds
          profile: requestBody.userProfileId
      - text: Change the project role of users {users} in project {project}.
        slots:
          project: path.projectId
          users: requestBody.userIds
      method: generated
      generated: '2026-10-01'