Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for NeoLoad Results|Events API

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

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

$.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/events/{eventId}'].patch

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|Events API
  version: 1.0.0
extends: openapi/tricentis-results-events-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}/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List events of a test result
      effect: read
      questions:
      - What errors and events happened during a load test?
      - Can I filter test result events by type?
      instructions:
      - text: List events of test result {result} in workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
      - text: Show {types} events from test result {result}.
        slots:
          result: path.resultId
          types: query.types
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a custom event to a test result
      effect: write
      questions:
      - Can I mark something that happened outside NeoLoad, like a deployment, on a test result?
      - How many custom events can a test result hold?
      instructions:
      - text: Add a custom event named {name} to test result {result} in workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
          name: requestBody.fullname
      - text: Record custom event {name} on result {result} from {start} to {end}.
        slots:
          name: requestBody.fullname
          result: path.resultId
          start: requestBody.startTimestamp
          end: requestBody.endTimestamp
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/events/{eventId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a custom event on a test result
      effect: write
      questions:
      - Can I change the end time of a custom event I already added?
      - How do I turn an instant custom event into a time range?
      instructions:
      - text: Set the end time of custom event {event} on test result {result} in workspace {ws} to {end}.
        slots:
          ws: path.workspaceId
          result: path.resultId
          event: path.eventId
          end: requestBody.endTimestamp
      - text: Update the description of custom event {event} on result {result} to {description}.
        slots:
          event: path.eventId
          result: path.resultId
          description: requestBody.description
      method: generated
      generated: '2026-10-01'