Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for qTest Manager API Version 3.0 Site Templates API

4 actions 4 updates phrasing extends openapi/tricentis-site-templates-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 4

$.info
$.paths['/api/v3/site-templates'].get
$.paths['/api/v3/site-templates/{templateId}/projects'].post
$.paths['/api/v3/site-templates/{templateId}/projects'].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 Manager API Version 3.0 Site Templates API
  version: 1.0.0
extends: openapi/tricentis-site-templates-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: 3
- target: $.paths['/api/v3/site-templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List site templates
      effect: read
      questions:
      - What site templates are available on our qTest site?
      - Which project templates can I apply?
      instructions:
      - text: List all site templates.
      - text: Show the site templates available to apply to projects.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/site-templates/{templateId}/projects'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a site template to existing projects
      effect: write
      questions:
      - How do I apply a site template to projects that already exist?
      - Can applying a template create new site field values?
      instructions:
      - text: Apply site template {template} to projects {projects}.
        slots:
          template: path.templateId
          projects: requestBody.project_ids
      - text: Link projects {projects} to template {template}.
        slots:
          template: path.templateId
          projects: requestBody.project_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/site-templates/{templateId}/projects'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove projects from a site template
      effect: destructive
      questions:
      - How do I detach projects from a site template?
      - Can I unlink projects from a template?
      instructions:
      - text: Remove projects from site template {template}.
        slots:
          template: path.templateId
      - text: Detach projects from template {template}.
        slots:
          template: path.templateId
      method: generated
      generated: '2026-10-01'