Tricentis · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/tricentis-v3-search-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/field'].get

$.paths['/api/search/list'].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 Search API
  version: 1.0.0
extends: openapi/tricentis-v3-search-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/field'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a session field for search
      effect: read
      questions:
      - Which values can I search sessions by for a given field?
      - Can I look up the field definition used in session search?
      instructions:
      - text: Get session field {field} in project {project}.
        slots:
          field: query.field
          project: query.project_id
      - text: Show the searchable field {field}.
        slots:
          field: query.field
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/search/list'].get
  update:
    x-apievangelist-phrasing:
      intent: Search sessions by field
      effect: read
      questions:
      - How do I search sessions in a project by a field?
      - Can I get a list of sessions matching a field?
      instructions:
      - text: Search sessions in project {project} by {field}.
        slots:
          project: query.project_id
          field: query.field
      - text: List sessions where {field} matches in project {project}.
        slots:
          field: query.field
          project: query.project_id
      method: generated
      generated: '2026-10-01'