Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for NeoLoad Tests|Test Analysis API

3 actions 3 updates phrasing extends openapi/tricentis-tests-test-analysis-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}/analysis'].get
$.paths['/v3/workspaces/{workspaceId}/tests/{testId}/analysis'].put

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|Test Analysis API
  version: 1.0.0
extends: openapi/tricentis-tests-test-analysis-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}/analysis'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a test analysis configuration
      effect: read
      questions:
      - How is test analysis configured for my test?
      - Which reference result is my test compared against?
      instructions:
      - text: Get the test analysis configuration of test {test} in workspace {ws}.
        slots:
          ws: path.workspaceId
          test: path.testId
      - text: Show the analysis objectives for test {test}.
        slots:
          test: path.testId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/tests/{testId}/analysis'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a test analysis configuration
      effect: write
      questions:
      - Can I make a test fail when it misses its analysis objective?
      - How do I change the reference test result used for comparison?
      instructions:
      - text: Set the reference result for test {test} in workspace {ws} to {reference}.
        slots:
          ws: path.workspaceId
          test: path.testId
          reference: requestBody.referenceTestResultId
      - text: Make test {test} fail on objective with a tolerance of {tolerance}.
        slots:
          test: path.testId
          tolerance: requestBody.objectiveTolerance
      method: generated
      generated: '2026-10-01'