Tricentis · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/api/export/image'].post
$.paths['/api/export/doc'].post
$.paths['/api/export/pdf'].post
$.paths['/api/export/testcase'].post
$.paths['/session/export/{exportId}'].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 Explorer | Sessions V3 Export API
  version: 1.0.0
extends: openapi/tricentis-v3-export-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: 5
- target: $.paths['/api/export/image'].post
  update:
    x-apievangelist-phrasing:
      intent: Export session screens as images
      effect: write
      questions:
      - Can I export the screens of a session as image files?
      - How do I pull screenshots out of a session?
      instructions:
      - text: Export the screens of session {session} as images.
        slots:
          session: requestBody.session_id
      - text: Export screens {screens} to images titled {title}.
        slots:
          screens: requestBody.screens
          title: requestBody.title
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/export/doc'].post
  update:
    x-apievangelist-phrasing:
      intent: Export session screens to Word
      effect: write
      questions:
      - Can I export a session's screens to a Word document?
      - Is a .docx report of a session possible?
      instructions:
      - text: Export session {session} to a Word document.
        slots:
          session: requestBody.session_id
      - text: Create a Word doc titled {title} from screens {screens}.
        slots:
          title: requestBody.title
          screens: requestBody.screens
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/export/pdf'].post
  update:
    x-apievangelist-phrasing:
      intent: Export session screens to PDF
      effect: write
      questions:
      - Can I export a session's screens as a PDF?
      - Which export gives me a session as a PDF report?
      instructions:
      - text: Export session {session} to PDF.
        slots:
          session: requestBody.session_id
      - text: Create a PDF titled {title} from screens {screens}.
        slots:
          title: requestBody.title
          screens: requestBody.screens
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/export/testcase'].post
  update:
    x-apievangelist-phrasing:
      intent: Export a session as a test case
      effect: write
      questions:
      - Can I turn an exploratory session into a test case?
      - How do I export session steps as test case steps?
      instructions:
      - text: Export session {session} as test case {name}.
        slots:
          session: requestBody.session_id
          name: requestBody.name
      - text: Create a test case export named {name} with steps {steps}.
        slots:
          name: requestBody.name
          steps: requestBody.steps
      method: generated
      generated: '2026-10-01'
- target: $.paths['/session/export/{exportId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an exported file
      effect: read
      questions:
      - Where do I download the result of a session export?
      - Can I fetch an exported file by its export id?
      instructions:
      - text: Download export {export}.
        slots:
          export: path.exportId
      - text: Get the file produced by export {export}.
        slots:
          export: path.exportId
      method: generated
      generated: '2026-10-01'