Tricentis · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/tricentis-users-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['/users'].get
$.paths['/users({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) Users API
  version: 1.0.0
extends: openapi/tricentis-users-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['/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users in the analytics feed
      effect: read
      questions:
      - Which users appear in the test analytics data?
      - Can I search analytics users by name?
      instructions:
      - text: List analytics users.
      - text: List analytics users matching {filter}.
        slots:
          filter: query.$filter
      - text: Search analytics users for {search}.
        slots:
          search: query.$search
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an analytics user by key
      effect: read
      questions:
      - How do I read one user record from the analytics feed?
      - Can I pick which fields come back for an analytics user?
      instructions:
      - text: Get analytics user {id}.
        slots:
          id: path.id
      - text: Show only {select} of analytics user {id}.
        slots:
          select: query.$select
          id: path.id
      method: generated
      generated: '2026-10-01'