Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for qTest Explorer | Sessions V2 System Information API

5 actions 5 updates phrasing extends openapi/tricentis-v2-system-information-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 5

$.info

$.paths['/sessions/{sessionId}/sys-infos'].post

$.paths['/sessions/{sessionId}/sys-infos/{sysInfoId}'].get

$.paths['/sessions/{sessionId}/sys-infos/{sysInfoId}'].put

$.paths['/sessions/{sessionId}/sys-infos/{sysInfoId}'].delete

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 V2 System Information API
  version: 1.0.0
extends: openapi/tricentis-v2-system-information-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: 4
- target: $.paths['/sessions/{sessionId}/sys-infos'].post
  update:
    x-apievangelist-phrasing:
      intent: Record system information for a session
      effect: write
      questions:
      - How do I record the OS and hardware a session ran on?
      - Can I store CPU and RAM details against an exploratory session?
      instructions:
      - text: Record OS {os} for session {session}.
        slots:
          os: requestBody.os
          session: path.sessionId
      - text: Add system info with CPU {cpu} and RAM {ram} to session {session}.
        slots:
          cpu: requestBody.cpu
          ram: requestBody.ram
          session: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sessions/{sessionId}/sys-infos/{sysInfoId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a session's system information
      effect: read
      questions:
      - What machine and OS was a session captured on?
      - Can I read one system information record of a session?
      instructions:
      - text: Get system info {sys_info} of session {session}.
        slots:
          sys_info: path.sysInfoId
          session: path.sessionId
      - text: Show the machine details {sys_info} recorded in session {session}.
        slots:
          sys_info: path.sysInfoId
          session: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sessions/{sessionId}/sys-infos/{sysInfoId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a session's system information
      effect: write
      questions:
      - Can I correct the OS or computer name stored on a session?
      - How do I edit the system details of a session?
      instructions:
      - text: Update system info {sys_info} in session {session} to OS {os}.
        slots:
          sys_info: path.sysInfoId
          session: path.sessionId
          os: requestBody.os
      - text: Set computer name {computer} on system info {sys_info} of session {session}.
        slots:
          computer: requestBody.computer_name
          sys_info: path.sysInfoId
          session: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sessions/{sessionId}/sys-infos/{sysInfoId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a session's system information
      effect: destructive
      questions:
      - Is it possible to remove the system details from a session?
      - Can I delete one system information record?
      instructions:
      - text: Delete system info {sys_info} from session {session}.
        slots:
          sys_info: path.sysInfoId
          session: path.sessionId
      - text: Remove machine details {sys_info} recorded in session {session}.
        slots:
          sys_info: path.sysInfoId
          session: path.sessionId
      method: generated
      generated: '2026-10-01'