Tricentis · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/tricentis-releases-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['/releases'].get
$.paths['/releases({id})'].get

OpenAPI Overlay

Raw ↑ 
# 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) Releases API
  version: 1.0.0
extends: openapi/tricentis-releases-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['/releases'].get
  update:
    x-apievangelist-phrasing:
      intent: List releases
      effect: read
      questions:
      - Which releases are recorded in the test analytics data?
      - Can I sort releases by a property such as name?
      instructions:
      - text: List all releases.
      - text: List releases matching {filter}.
        slots:
          filter: query.$filter
      - text: Show releases ordered by {orderby}.
        slots:
          orderby: query.$orderby
      method: generated
      generated: '2026-10-01'
- target: $.paths['/releases({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a release by key
      effect: read
      questions:
      - How do I read one release record by its key?
      - Can I return only some fields of a release?
      instructions:
      - text: Get release {id}.
        slots:
          id: path.id
      - text: Show only {select} of release {id}.
        slots:
          select: query.$select
          id: path.id
      method: generated
      generated: '2026-10-01'