Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tricentis Projects API

4 actions 4 updates phrasing extends openapi/tricentis-projects-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 4

$.info
$.paths['/projects'].get
$.paths['/projects({id})'].get
$.paths['/v1/projects'].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 Projects API
  version: 1.0.0
extends: openapi/tricentis-projects-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: 3
- target: $.paths['/projects'].get
  update:
    x-apievangelist-phrasing:
      intent: List projects in the analytics feed
      effect: read
      questions:
      - Which projects appear in the test analytics data?
      - Can I filter analytics projects by a property value?
      instructions:
      - text: List analytics projects.
      - text: List analytics projects matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an analytics project by key
      effect: read
      questions:
      - How do I read one project record from the analytics feed?
      - Can I choose which fields come back for one analytics project?
      instructions:
      - text: Get analytics project {id}.
        slots:
          id: path.id
      - text: Show only {select} for analytics project {id}.
        slots:
          select: query.$select
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects'].get
  update:
    x-apievangelist-phrasing:
      intent: List Jira projects
      effect: read
      questions:
      - Which Jira projects can I manage tests in?
      - Can I look up specific Jira projects by their keys?
      instructions:
      - text: List my Jira projects.
      - text: Get the Jira projects with keys {keys}.
        slots:
          keys: query.keys
      method: generated
      generated: '2026-10-01'