Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for qTest Explorer | Sessions V4 Query API

5 actions 5 updates phrasing extends openapi/tricentis-v4-query-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['/api/v4/query'].post
$.paths['/api/v4/query/{queryid}'].put
$.paths['/api/v4/query/{queryid}'].delete
$.paths['/api/v4/query/share'].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 V4 Query API
  version: 1.0.0
extends: openapi/tricentis-v4-query-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['/api/v4/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a saved session query
      effect: write
      questions:
      - How do I save a new query for finding sessions?
      - Can I share a new query with my team when I create it?
      instructions:
      - text: Create query {name} in project {project}.
        slots:
          name: requestBody.name
          project: requestBody.projectId
      - text: Save team query {name} with clauses {clauses}, team {is_team}.
        slots:
          name: requestBody.name
          clauses: requestBody.queryClauses
          is_team: requestBody.isTeam
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v4/query/{queryid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a saved session query
      effect: write
      questions:
      - Can I rename a saved query or change its clauses?
      - What changes can I make to an existing session query?
      instructions:
      - text: Rename query {query} to {name}.
        slots:
          query: path.queryid
          name: requestBody.name
      - text: Update the clauses of query {query} to {clauses}.
        slots:
          query: path.queryid
          clauses: requestBody.query_clauses
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v4/query/{queryid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a saved session query
      effect: destructive
      questions:
      - Is there a way to delete a saved query?
      - Can I remove one session query by id?
      instructions:
      - text: Delete query {query}.
        slots:
          query: path.queryid
      - text: Remove saved session query {query}.
        slots:
          query: path.queryid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v4/query/share'].put
  update:
    x-apievangelist-phrasing:
      intent: Share saved queries
      effect: write
      questions:
      - How do I share my saved queries with others?
      - Can I share several queries at once?
      instructions:
      - text: Share my selected queries.
      - text: Share these saved session queries with the team.
      method: generated
      generated: '2026-10-01'