Tricentis · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/tricentis-v3-query-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/query/sessions/tree'].get

$.paths['/api/query/sessions/{queryid}'].get

$.paths['/api/query/sessions/{queryid}/statistic'].get

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 Query API
  version: 1.0.0
extends: openapi/tricentis-v3-query-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/query/sessions/tree'].get
  update:
    x-apievangelist-phrasing:
      intent: List saved session queries
      effect: read
      questions:
      - Which saved session queries exist in my project?
      - Can I see the folder tree of session queries?
      instructions:
      - text: Get the query tree for project {project}.
        slots:
          project: query.projectId
      - text: List saved session queries in project {project}.
        slots:
          project: query.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/query/sessions/{queryid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a saved session query
      effect: read
      questions:
      - How do I run a saved query to list matching sessions?
      - Can I sort and page the results of a session query?
      instructions:
      - text: Run query {query} in project {project}, page {page} of size {size}, sorted by {sort_by} {sort_order}.
        slots:
          query: path.queryid
          project: query.projectId
          page: query.p
          size: query.recs
          sort_by: query.sortBy
          sort_order: query.sortOrder
      - text: Execute session query {query} for project {project} ordered by {sort_by} {sort_order}, page {page}, {size} rows.
        slots:
          query: path.queryid
          project: query.projectId
          sort_by: query.sortBy
          sort_order: query.sortOrder
          page: query.p
          size: query.recs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/query/sessions/{queryid}/statistic'].get
  update:
    x-apievangelist-phrasing:
      intent: Get statistics for a session query
      effect: read
      questions:
      - How many sessions does a saved query match?
      - Can I get summary statistics for a query?
      instructions:
      - text: Get statistics for query {query} in project {project}.
        slots:
          query: path.queryid
          project: query.projectId
      - text: Summarize the results of session query {query} in {project}.
        slots:
          query: path.queryid
          project: query.projectId
      method: generated
      generated: '2026-10-01'