Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for NeoLoad Information API

3 actions 3 updates phrasing extends openapi/tricentis-information-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/information'].get

$.paths['/v3/usage'].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 Information API
  version: 1.0.0
extends: openapi/tricentis-information-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/information'].get
  update:
    x-apievangelist-phrasing:
      intent: Get NeoLoad Web version and resource info
      effect: read
      questions:
      - What version of NeoLoad Web am I connected to?
      - Where can I find information about my NeoLoad Web resources?
      instructions:
      - text: Show NeoLoad Web version and resource information.
      - text: Get the platform information for this instance.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/usage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get usage data
      effect: read
      questions:
      - How much have we used NeoLoad Web this month?
      - Can I export usage data for a date range as CSV?
      instructions:
      - text: Get usage data as {format}.
        slots:
          format: query.format
      - text: Export usage from {from} to {to} in {format}.
        slots:
          from: query.fromDateTime
          to: query.toDateTime
          format: query.format
      method: generated
      generated: '2026-10-01'