Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for NeoLoad Results|Monitors API

6 actions 6 updates phrasing extends openapi/tricentis-results-monitors-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 6

$.info

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

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

$.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/monitors/{counterId}'].get

$.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/monitors/{counterId}/values'].get

$.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/monitors/{counterId}/points'].get

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|Monitors API
  version: 1.0.0
extends: openapi/tricentis-results-monitors-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: 5
- target: $.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/monitors'].get
  update:
    x-apievangelist-phrasing:
      intent: List monitor counters of a test result
      effect: read
      questions:
      - Which monitors and counters were collected for a test result?
      - Can I see all monitoring counters for one load test result?
      instructions:
      - text: List the monitor counters of test result {result} in workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
      - text: Show every monitor collected for result {result}, workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/monitors'].post
  update:
    x-apievangelist-phrasing:
      intent: Push custom monitor data to a running test
      effect: write
      questions:
      - Can I send my own external metrics into a test while it is running?
      - What limits apply to pushing custom monitor values, like one value per second?
      instructions:
      - text: Push custom monitor data {monitors} to running test result {result} in workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
          monitors: requestBody.monitors
      - text: Send these external metrics {monitors} to result {result}, workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
          monitors: requestBody.monitors
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/monitors/{counterId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a monitor counter definition
      effect: read
      questions:
      - What does a specific monitor counter measure and in what unit?
      - How can I read the definition of one counter on a test result?
      instructions:
      - text: Get the definition of counter {counter} for test result {result} in workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
          counter: path.counterId
      - text: Describe monitor counter {counter} on result {result}, workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
          counter: path.counterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/monitors/{counterId}/values'].get
  update:
    x-apievangelist-phrasing:
      intent: Get summary values of a monitor counter
      effect: read
      questions:
      - What were the values of a given monitor counter during a test?
      - Can I get the aggregated values for one counter of a test result?
      instructions:
      - text: Get the values of counter {counter} for test result {result} in workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
          counter: path.counterId
      - text: Show summary values for monitor {counter} on result {result}, workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
          counter: path.counterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/monitors/{counterId}/points'].get
  update:
    x-apievangelist-phrasing:
      intent: Get time-series points of a monitor counter
      effect: read
      questions:
      - Can I get the time series of a counter averaged over intervals?
      - Where do I get data points to chart a monitor over the test duration?
      instructions:
      - text: Get the data points of counter {counter} for test result {result} in workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
          counter: path.counterId
      - text: Fetch the time series for monitor {counter} on result {result}, workspace {ws}, to chart it.
        slots:
          ws: path.workspaceId
          result: path.resultId
          counter: path.counterId
      method: generated
      generated: '2026-10-01'