Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tricentis Defects API

5 actions 5 updates phrasing extends openapi/tricentis-defects-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 5

$.info
$.paths['/defects'].get
$.paths['/defects({id})'].get
$.paths['/v1/projects/{project-key}/test-runs/{test-run-key}/defects'].post
$.paths['/v1/projects/{project-key}/test-runs/{test-run-key}/defects/link'].post

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 Defects API
  version: 1.0.0
extends: openapi/tricentis-defects-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: 4
- target: $.paths['/defects'].get
  update:
    x-apievangelist-phrasing:
      intent: List defects in the analytics feed
      effect: read
      questions:
      - Which defects are recorded in the test analytics data?
      - Can I count defects that match a filter?
      instructions:
      - text: List all defects.
      - text: List defects matching {filter}.
        slots:
          filter: query.$filter
      - text: Search defects for {search}.
        slots:
          search: query.$search
      method: generated
      generated: '2026-10-01'
- target: $.paths['/defects({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a defect by key
      effect: read
      questions:
      - Where can I read one defect record by its key?
      - Can I return only a few fields of a defect?
      instructions:
      - text: Get defect {id}.
        slots:
          id: path.id
      - text: Show only {select} of defect {id}.
        slots:
          select: query.$select
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{project-key}/test-runs/{test-run-key}/defects'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a defect from a test run
      effect: write
      questions:
      - How do I raise a new Jira bug from a failed test run?
      - Can I attach a newly created defect to one step of the run?
      instructions:
      - text: Create a defect on test run {test_run} in project {project}.
        slots:
          test_run: path.test-run-key
          project: path.project-key
      - text: Raise a new bug for step {step} of run {test_run} in {project}.
        slots:
          step: query.stepIndex
          test_run: path.test-run-key
          project: path.project-key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{project-key}/test-runs/{test-run-key}/defects/link'].post
  update:
    x-apievangelist-phrasing:
      intent: Link existing defects to a test run
      effect: write
      questions:
      - Can I link a Jira issue that already exists to a test run?
      - How do I connect an existing bug to a specific run step?
      instructions:
      - text: Link existing defects to run {test_run} in project {project}.
        slots:
          test_run: path.test-run-key
          project: path.project-key
      - text: Link an existing issue to step {step} of run {test_run} in {project}.
        slots:
          step: query.stepIndex
          test_run: path.test-run-key
          project: path.project-key
      method: generated
      generated: '2026-10-01'