Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for NeoLoad Results|SLAs API

4 actions 4 updates phrasing extends openapi/tricentis-results-slas-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}/slas/statistics'].get

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

$.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/slas/per-interval'].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|SLAs API
  version: 1.0.0
extends: openapi/tricentis-results-slas-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}/slas/statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get overall SLA indicators of a test result
      effect: read
      questions:
      - Did my load test pass its global SLAs?
      - What are the overall SLA indicators for a test result?
      instructions:
      - text: Get the global SLA indicators of test result {result} in workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
      - text: Show global SLA indicators with status {status} for result {result}.
        slots:
          result: path.resultId
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/slas/per-test'].get
  update:
    x-apievangelist-phrasing:
      intent: Get per-test SLA results
      effect: read
      questions:
      - Which elements failed their per-test SLAs across the whole run?
      - Can I filter per-test SLAs by element category?
      instructions:
      - text: Get the whole-run SLA result for each element of test result {result} in workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
      - text: Show per-test SLAs of category {category} with status {status} for result {result}.
        slots:
          result: path.resultId
          category: query.category
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/slas/per-interval'].get
  update:
    x-apievangelist-phrasing:
      intent: Get per-interval SLA results
      effect: read
      questions:
      - When during the test did SLAs start failing?
      - Can I see SLA results broken down by time interval?
      instructions:
      - text: Break down SLA results by time interval for test result {result} in workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
      - text: Show per-interval SLA breaches of category {category} for result {result}.
        slots:
          result: path.resultId
          category: query.category
      method: generated
      generated: '2026-10-01'