Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for TTM for Jira Test Runs Fields API

3 actions 3 updates phrasing extends openapi/tricentis-test-runs-fields-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['/v1/test-runs/scheme/{schemeName}/allowed-values'].post
$.paths['/v1/test-runs/scheme/{schemeName}/allowed-values/{allowedValueName}'].delete

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 TTM for Jira Test Runs Fields API
  version: 1.0.0
extends: openapi/tricentis-test-runs-fields-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['/v1/test-runs/scheme/{schemeName}/allowed-values'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an allowed environment or build value
      effect: write
      questions:
      - How do I add a new environment option for test runs?
      - Can I register a new build name as an allowed value?
      instructions:
      - text: Add an allowed value to scheme {scheme}.
        slots:
          scheme: path.schemeName
      - text: Add a new option to the {scheme} list for test runs.
        slots:
          scheme: path.schemeName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/test-runs/scheme/{schemeName}/allowed-values/{allowedValueName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an allowed environment or build value
      effect: destructive
      questions:
      - Can I remove an environment that is no longer used from test runs?
      - Can I delete an allowed build value?
      instructions:
      - text: Delete allowed value {value} from scheme {scheme}.
        slots:
          value: path.allowedValueName
          scheme: path.schemeName
      - text: Remove {value} from the {scheme} options.
        slots:
          value: path.allowedValueName
          scheme: path.schemeName
      method: generated
      generated: '2026-10-01'