Tricentis · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/tricentis-requirementsets-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['/requirementsets'].get
$.paths['/requirementsets({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) Requirementsets API
  version: 1.0.0
extends: openapi/tricentis-requirementsets-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['/requirementsets'].get
  update:
    x-apievangelist-phrasing:
      intent: List requirement sets
      effect: read
      questions:
      - Which requirement sets exist in the analytics data?
      - Can I filter requirement sets by a property?
      instructions:
      - text: List all requirement sets.
      - text: List requirement sets matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/requirementsets({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a requirement set by key
      effect: read
      questions:
      - How do I read one requirement set by its key?
      - Can I select certain fields of a requirement set?
      instructions:
      - text: Get requirement set {id}.
        slots:
          id: path.id
      - text: Show only {select} of requirement set {id}.
        slots:
          select: query.$select
          id: path.id
      method: generated
      generated: '2026-10-01'