Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for qTest Manager API Version 3.0 Automation Job API

3 actions 3 updates phrasing extends openapi/tricentis-automation-job-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/v3/automation/automation-agents'].post
$.paths['/api/v3/automation/jobs/schedule/create'].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 Manager API Version 3.0 Automation Job API
  version: 1.0.0
extends: openapi/tricentis-automation-job-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/v3/automation/automation-agents'].post
  update:
    x-apievangelist-phrasing:
      intent: Search automation agents
      effect: read
      questions:
      - Which automation agents are available in my projects?
      - Can I filter automation agents by framework or name?
      instructions:
      - text: Find automation agents matching {query}.
        slots:
          query: requestBody.query
      - text: List automation agents showing only fields {fields}.
        slots:
          fields: requestBody.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/automation/jobs/schedule/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule an automation run on an agent
      effect: write
      questions:
      - How do I kick off automated test runs on an agent right away?
      - Can I schedule specific test runs to execute on an automation host?
      instructions:
      - text: Schedule test runs {runs} on agent {agent} in project {project}.
        slots:
          runs: requestBody.testRunIds
          agent: requestBody.agentId
          project: requestBody.projectId
      - text: Create a schedule {name} on agent {agent} for project {project} starting {start}.
        slots:
          name: requestBody.name
          agent: requestBody.agentId
          project: requestBody.projectId
          start: requestBody.startDate
      method: generated
      generated: '2026-10-01'