Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for qTest Explorer | Sessions V3 Config API

4 actions 4 updates phrasing extends openapi/tricentis-v3-config-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 4

$.info

$.paths['/api/config'].get

$.paths['/api/user-settings'].get

$.paths['/api/user-settings'].put

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for qTest Explorer | Sessions V3 Config API
  version: 1.0.0
extends: openapi/tricentis-v3-config-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: 3
- target: $.paths['/api/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current app configuration
      effect: read
      questions:
      - What configuration is the exploratory testing app running with?
      - Can I read the current server config?
      instructions:
      - text: Get the current config.
      - text: Show the active application configuration.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my user settings
      effect: read
      questions:
      - What are my personal session settings?
      - Can I read my current user preferences?
      instructions:
      - text: Get my user settings.
      - text: Show the preferences saved for my user.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Update my user settings
      effect: write
      questions:
      - How do I change my personal session preferences?
      - Can I save new session defaults for my user?
      instructions:
      - text: Update my session settings to {session}.
        slots:
          session: requestBody.session
      - text: Save my user preferences with session defaults {session}.
        slots:
          session: requestBody.session
      method: generated
      generated: '2026-10-01'