Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for qTest Explorer | Sessions V3 Application Information API

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

$.info
$.paths['/api/sessions/{sessionId}/app-infos'].get
$.paths['/api/sessions/{sessionId}/app-infos'].put
$.paths['/api/sessions/{sessionId}/app-infos'].post
$.paths['/api/sessions/{sessionId}/app-infos/{appInfoId}'].get
$.paths['/api/sessions/{sessionId}/app-infos/{appInfoId}'].put
$.paths['/api/sessions/{sessionId}/app-infos/{appInfoId}'].delete

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 Explorer | Sessions V3 Application Information API
  version: 1.0.0
extends: openapi/tricentis-v3-application-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: 6
- target: $.paths['/api/sessions/{sessionId}/app-infos'].get
  update:
    x-apievangelist-phrasing:
      intent: List a session's application info
      effect: read
      questions:
      - Which applications were captured during an exploratory session?
      - Can I see the app versions recorded for a session?
      instructions:
      - text: List the application info for session {session}.
        slots:
          session: path.sessionId
      - text: Show which apps were used in exploratory session {session}.
        slots:
          session: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sessions/{sessionId}/app-infos'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a session's application info list
      effect: write
      questions:
      - Can I update the whole list of applications on a session at once?
      - Is there a bulk update for a session's captured app details?
      instructions:
      - text: Replace the application info list of session {session}.
        slots:
          session: path.sessionId
      - text: Update all app entries recorded on session {session} together.
        slots:
          session: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sessions/{sessionId}/app-infos'].post
  update:
    x-apievangelist-phrasing:
      intent: Add application info to a session
      effect: write
      questions:
      - How do I record a new application against an exploratory session?
      - What must I supply when adding an app to a session?
      instructions:
      - text: Add app {name} first used at {first_action_time} to session {session}.
        slots:
          name: requestBody.name
          first_action_time: requestBody.first_action_time
          session: path.sessionId
      - text: Record application {name} version {version} on session {session}.
        slots:
          name: requestBody.name
          version: requestBody.version
          session: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sessions/{sessionId}/app-infos/{appInfoId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one application info entry
      effect: read
      questions:
      - Can I read a single application entry captured in a session?
      - What file path and version were stored for one app in a session?
      instructions:
      - text: Get app info {app_info} of session {session}.
        slots:
          app_info: path.appInfoId
          session: path.sessionId
      - text: Show application entry {app_info} recorded in session {session}.
        slots:
          app_info: path.appInfoId
          session: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sessions/{sessionId}/app-infos/{appInfoId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one application info entry
      effect: write
      questions:
      - Can I correct the name or version of one captured application?
      - How do I edit a single app record on a session?
      instructions:
      - text: Update app info {app_info} in session {session} to name {name}, first used {first_action_time}.
        slots:
          app_info: path.appInfoId
          session: path.sessionId
          name: requestBody.name
          first_action_time: requestBody.first_action_time
      - text: Set the version of app entry {app_info} in session {session} to {version}.
        slots:
          app_info: path.appInfoId
          session: path.sessionId
          version: requestBody.version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sessions/{sessionId}/app-infos/{appInfoId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an application info entry
      effect: destructive
      questions:
      - How do I remove an application captured by mistake from a session?
      - Can I delete one app entry from a session?
      instructions:
      - text: Delete app info {app_info} from session {session}.
        slots:
          app_info: path.appInfoId
          session: path.sessionId
      - text: Remove application entry {app_info} recorded in session {session}.
        slots:
          app_info: path.appInfoId
          session: path.sessionId
      method: generated
      generated: '2026-10-01'