Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for qTest Manager API Version 3.0 Common API

3 actions 3 updates phrasing extends openapi/tricentis-common-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['/api/v3/projects/{projectId}/settings/{objectType}/custom-fields/active'].post
$.paths['/api/v3/projects/{projectId}/settings/{objectType}/system-fields/{fieldId}'].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 qTest Manager API Version 3.0 Common API
  version: 1.0.0
extends: openapi/tricentis-common-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['/api/v3/projects/{projectId}/settings/{objectType}/custom-fields/active'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate or deactivate custom fields
      effect: write
      questions:
      - How do I turn custom fields on or off for test cases?
      - Can I deactivate custom fields on defects in a project?
      instructions:
      - text: Update which custom fields are active for {objectType} in project {project}.
        slots:
          project: path.projectId
          objectType: path.objectType
      - text: Deactivate custom fields on {objectType} in project {project}.
        slots:
          project: path.projectId
          objectType: path.objectType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/{objectType}/system-fields/{fieldId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Edit a system field
      effect: write
      questions:
      - Can I relabel a built-in system field like Priority?
      - How do I change the allowed values of a system field?
      instructions:
      - text: Relabel system field {field} on {objectType} in project {project} to {label}.
        slots:
          project: path.projectId
          field: path.fieldId
          objectType: path.objectType
          label: requestBody.label
      - text: Make system field {field} on {objectType} required with label {label}.
        slots:
          field: path.fieldId
          objectType: path.objectType
          label: requestBody.label
      method: generated
      generated: '2026-10-01'