Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for qTest Data Export Access Files API

3 actions 3 updates phrasing extends openapi/tricentis-accessfiles-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['/files'].get

$.paths['/file/{filepath}'].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 Data Export Access Files API
  version: 1.0.0
extends: openapi/tricentis-accessfiles-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['/files'].get
  update:
    x-apievangelist-phrasing:
      intent: List downloadable data files
      effect: read
      questions:
      - Which data export files are available for my organization to download?
      - Can I list only the files inside one dated directory?
      - How do I page through a long list of export files?
      instructions:
      - text: List the available data files.
      - text: List the files under directory {directory}.
        slots:
          directory: query.directoryFilter
      - text: Show the next page of files using page token {page_token}.
        slots:
          page_token: query.pageToken
      method: generated
      generated: '2026-10-01'
- target: $.paths['/file/{filepath}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a data file
      effect: read
      questions:
      - Can I download one parquet part file by its full path?
      - What order should I read multi-part export files in?
      instructions:
      - text: Download the file at {filepath}.
        slots:
          filepath: path.filepath
      - text: Fetch file {filepath} so I can load it.
        slots:
          filepath: path.filepath
      method: generated
      generated: '2026-10-01'