Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for qTest Explorer | Sessions V2 Resource API

6 actions 6 updates phrasing extends openapi/tricentis-v2-resource-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['/sessions/{sessionId}/resources'].get
$.paths['/sessions/{sessionId}/resources/{resourceId}'].get
$.paths['/sessions/{sessionId}/resources/{resourceId}'].delete
$.paths['/sessions/{sessionId}/resources/{resourceId}/download'].get
$.paths['/sessions/{sessionId}/resources/upload'].post

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 V2 Resource API
  version: 1.0.0
extends: openapi/tricentis-v2-resource-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['/sessions/{sessionId}/resources'].get
  update:
    x-apievangelist-phrasing:
      intent: List a session's resources
      effect: read
      questions:
      - Which files are attached to an exploratory session?
      - Can I list all resources uploaded to a session?
      instructions:
      - text: List the resources of session {session}.
        slots:
          session: path.sessionId
      - text: Show every file attached to session {session}.
        slots:
          session: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sessions/{sessionId}/resources/{resourceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a session resource's details
      effect: read
      questions:
      - Can I read the metadata of one resource in a session?
      - What is stored about a single uploaded session file?
      instructions:
      - text: Get resource {resource} of session {session}.
        slots:
          resource: path.resourceId
          session: path.sessionId
      - text: Show metadata for resource {resource} in session {session}.
        slots:
          resource: path.resourceId
          session: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sessions/{sessionId}/resources/{resourceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a session resource
      effect: destructive
      questions:
      - How do I remove a file attached to a session?
      - Can I delete one resource from a session?
      instructions:
      - text: Delete resource {resource} from session {session}.
        slots:
          resource: path.resourceId
          session: path.sessionId
      - text: Remove attached file {resource} in session {session}.
        slots:
          resource: path.resourceId
          session: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sessions/{sessionId}/resources/{resourceId}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a session resource
      effect: read
      questions:
      - How do I download a file that was attached to a session?
      - Can I get the raw content of a session resource?
      instructions:
      - text: Download resource {resource} of session {session}.
        slots:
          resource: path.resourceId
          session: path.sessionId
      - text: Save the file content of resource {resource} from session {session}.
        slots:
          resource: path.resourceId
          session: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sessions/{sessionId}/resources/upload'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a resource to a session
      effect: write
      questions:
      - How do I attach a file to an exploratory session?
      - Can I upload a log file as a session resource?
      instructions:
      - text: Upload {file} to session {session}.
        slots:
          file: requestBody.file
          session: path.sessionId
      - text: Attach file {file} as a resource of session {session}.
        slots:
          file: requestBody.file
          session: path.sessionId
      method: generated
      generated: '2026-10-01'