Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for qTest Explorer | Sessions V3 Project Settings API

3 actions 3 updates phrasing extends openapi/tricentis-v3-project-settings-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/project-settings/{projectId}'].get
$.paths['/api/project-settings/{projectId}'].put

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 Explorer | Sessions V3 Project Settings API
  version: 1.0.0
extends: openapi/tricentis-v3-project-settings-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/project-settings/{projectId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project's session settings
      effect: read
      questions:
      - What note types and time types does a project use for sessions?
      - Can I read the session settings of one project?
      instructions:
      - text: Get the settings of project {project}.
        slots:
          project: path.projectId
      - text: Show session note and time types for project {project}.
        slots:
          project: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/project-settings/{projectId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a project's session settings
      effect: write
      questions:
      - How do I change the note types available in a project?
      - Can I set the category used for a project's sessions?
      instructions:
      - text: Set note types {note_types} for project {project}.
        slots:
          note_types: requestBody.note_types
          project: path.projectId
      - text: Update project {project} settings with category {category}.
        slots:
          project: path.projectId
          category: requestBody.category
      method: generated
      generated: '2026-10-01'