Tricentis · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/api/upload'].get
$.paths['/api/upload'].post
$.paths['/api/upload'].delete
$.paths['/upload-objects'].post
$.paths['/media'].get
$.paths['/media'].delete

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 Upload API
  version: 1.0.0
extends: openapi/tricentis-v3-upload-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: 6
- target: $.paths['/api/upload'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an uploaded resource by key
      effect: read
      questions:
      - Can I fetch an uploaded resource by its key?
      - Where do I retrieve a file I uploaded earlier?
      instructions:
      - text: Get uploaded resource {key}.
        slots:
          key: query.key
      - text: Fetch resource {key} with action {action}.
        slots:
          key: query.key
          action: query.action
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/upload'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a resource
      effect: write
      questions:
      - How do I upload a standalone resource file?
      - Can I upload a file and get back a key for it?
      instructions:
      - text: Upload resource file {file}.
        slots:
          file: requestBody.file
      - text: Store {file} as a new resource.
        slots:
          file: requestBody.file
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/upload'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an uploaded resource
      effect: destructive
      questions:
      - How do I delete a resource I uploaded?
      - Can I remove an uploaded resource by key?
      instructions:
      - text: Delete uploaded resource {key}.
        slots:
          key: query.key
      - text: Remove the resource stored under key {key}.
        slots:
          key: query.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/upload-objects'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a media file
      effect: write
      questions:
      - How do I upload a file as a media object?
      - Can I store a media object for later use?
      instructions:
      - text: Upload media file {file}.
        slots:
          file: requestBody.file
      - text: Store {file} as a new media object.
        slots:
          file: requestBody.file
      method: generated
      generated: '2026-10-01'
- target: $.paths['/media'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a media file by key
      effect: read
      questions:
      - Can I fetch an uploaded media object by key?
      - Where do I retrieve a media file I stored?
      instructions:
      - text: Get media {key}.
        slots:
          key: query.key
      - text: Fetch media object {key} with action {action}.
        slots:
          key: query.key
          action: query.action
      method: generated
      generated: '2026-10-01'
- target: $.paths['/media'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a media file
      effect: destructive
      questions:
      - How do I delete a media object?
      - Can I remove stored media by key?
      instructions:
      - text: Delete media {key}.
        slots:
          key: query.key
      - text: Remove the media object stored under {key}.
        slots:
          key: query.key
      method: generated
      generated: '2026-10-01'