Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for qTest Manager API Version 3.0 Groups API

3 actions 3 updates phrasing extends openapi/tricentis-groups-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 3

$.info
$.paths['/api/v3/groups'].get
$.paths['/api/v3/groups'].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 Groups API
  version: 1.0.0
extends: openapi/tricentis-groups-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: 2
- target: $.paths['/api/v3/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List user groups
      effect: read
      questions:
      - Which user groups exist on the instance?
      - Can I see both system and custom user groups?
      instructions:
      - text: List all user groups.
      - text: Show every system and custom user group.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom user group
      effect: write
      questions:
      - How do I create a custom user group with specific permissions?
      - Can I add users to a group when I create it?
      instructions:
      - text: Create a user group named {name}.
        slots:
          name: requestBody.name
      - text: Create group {name} with authorities {authorities} and users {users}.
        slots:
          name: requestBody.name
          authorities: requestBody.authority_names
          users: requestBody.user_ids
      method: generated
      generated: '2026-10-01'