Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for qTest Parameters Tasks API

3 actions 3 updates phrasing extends openapi/tricentis-tasks-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/v1/tasks/{id}'].get
$.paths['/api/v1/tasks/{id}/result'].get

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 Parameters Tasks API
  version: 1.0.0
extends: openapi/tricentis-tasks-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/v1/tasks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an import or export task
      effect: read
      questions:
      - How do I check the progress of an import or export task?
      - Has my background task finished yet?
      instructions:
      - text: Get task {id}.
        slots:
          id: path.id
      - text: Show the progress of task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/tasks/{id}/result'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a finished task's result
      effect: read
      questions:
      - Where do I read the outcome of a completed import task?
      - What did my finished background task return?
      instructions:
      - text: Get the result of task {id}.
        slots:
          id: path.id
      - text: Fetch the outcome of completed task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'