Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tricentis Analytics (Tech Review) Testsuites API

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

$.paths['/testsuites({id})'].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 Tricentis Analytics (Tech Review) Testsuites API
  version: 1.0.0
extends: openapi/tricentis-test-suites-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['/testsuites'].get
  update:
    x-apievangelist-phrasing:
      intent: List test suites
      effect: read
      questions:
      - Which test suites are in the test analytics data?
      - Can I filter test suites by a property value?
      instructions:
      - text: List all test suites.
      - text: List test suites matching {filter}.
        slots:
          filter: query.$filter
      - text: Show the first {top} test suites.
        slots:
          top: query.$top
      method: generated
      generated: '2026-10-01'
- target: $.paths['/testsuites({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a test suite by key
      effect: read
      questions:
      - How do I read one test suite by its key?
      - Can I select only a few fields of a test suite?
      instructions:
      - text: Get test suite {id}.
        slots:
          id: path.id
      - text: Show only {select} of test suite {id}.
        slots:
          select: query.$select
          id: path.id
      method: generated
      generated: '2026-10-01'