Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for NeoLoad Tests|Runtime API

3 actions 3 updates phrasing extends openapi/tricentis-tests-runtime-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['/v3/workspaces/{workspaceId}/tests/{testId}/start'].post
$.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/stop'].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 NeoLoad Tests|Runtime API
  version: 1.0.0
extends: openapi/tricentis-tests-runtime-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['/v3/workspaces/{workspaceId}/tests/{testId}/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a test
      effect: write
      questions:
      - How do I launch a test from the API?
      - Can I start a test with a reservation or a set number of web virtual users?
      instructions:
      - text: Start test {test} in workspace {ws} and name the result {name}.
        slots:
          test: path.testId
          ws: path.workspaceId
          name: query.testResultName
      - text: Run test {test} in workspace {ws} as result {name} using reservation {reservation}.
        slots:
          test: path.testId
          ws: path.workspaceId
          name: query.testResultName
          reservation: query.reservationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a running test
      effect: destructive
      questions:
      - Can I stop a test that is still running?
      - What's the difference between a graceful stop and terminate?
      instructions:
      - text: Stop running test result {result} in workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
      - text: Terminate result {result} in workspace {ws} with stop policy {policy}.
        slots:
          ws: path.workspaceId
          result: path.resultId
          policy: requestBody.stopPolicy
      method: generated
      generated: '2026-10-01'