Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for NeoLoad Results|Reporting API

4 actions 4 updates phrasing extends openapi/tricentis-results-reporting-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['/v3/workspaces/{workspaceId}/test-results/{resultId}/graph'].post

$.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/report'].post

$.paths['/v3/workspaces/{workspaceId}/test-results/graph'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for NeoLoad Results|Reporting API
  version: 1.0.0
extends: openapi/tricentis-results-reporting-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['/v3/workspaces/{workspaceId}/test-results/{resultId}/graph'].post
  update:
    x-apievangelist-phrasing:
      intent: Render a graph for one test result
      effect: read
      questions:
      - Can I get a chart image of response times and monitors for a test result?
      - What size limits apply to a graph of a single test result?
      instructions:
      - text: Render a graph of elements {elements} for test result {result} in workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
          elements: requestBody.elementIds
      - text: Draw a chart titled {title} of counters {counters} for result {result}, workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
          title: requestBody.title
          counters: requestBody.counterIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/report'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a PDF report of a test result
      effect: read
      questions:
      - Can I download a PDF report of a test result?
      - Is the test result report available in another language or time zone?
      instructions:
      - text: Generate the PDF report for test result {result} in workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
      - text: Get the PDF report of result {result}, workspace {ws}, in {language}.
        slots:
          ws: path.workspaceId
          result: path.resultId
          language: requestBody.language
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/test-results/graph'].post
  update:
    x-apievangelist-phrasing:
      intent: Render a graph comparing test results
      effect: read
      questions:
      - How can I compare several test results on one chart?
      - What is the maximum size of a multi-result graph?
      instructions:
      - text: Render a comparison graph of results {results} in workspace {ws}.
        slots:
          results: requestBody.resultIds
          ws: path.workspaceId
      - text: Chart test results {results} together in workspace {ws} with title {title}.
        slots:
          results: requestBody.resultIds
          ws: path.workspaceId
          title: requestBody.title
      method: generated
      generated: '2026-10-01'