Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for qTest Pulse Trigger API

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

$.info
$.paths['/triggers'].get
$.paths['/triggers'].post
$.paths['/triggers/{id}'].get
$.paths['/triggers/{id}'].put
$.paths['/triggers/{id}'].delete
$.paths['/triggers/{id}'].patch

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 Pulse Trigger API
  version: 1.0.0
extends: openapi/tricentis-trigger-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: 6
- target: $.paths['/triggers'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's Pulse triggers
      effect: read
      questions:
      - Which triggers are defined in my Pulse project?
      - Can I page through Pulse triggers with an offset?
      instructions:
      - text: List the triggers in project {project}.
        slots:
          project: query.projectId
      - text: Show the first {first} triggers of project {project}.
        slots:
          first: query.first
          project: query.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/triggers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Pulse trigger
      effect: write
      questions:
      - How do I create a trigger that Pulse rules can fire on?
      - What does a new Pulse trigger need besides a name?
      instructions:
      - text: Create trigger {name} in project {project}.
        slots:
          name: requestBody.name
          project: requestBody.projectId
      - text: Add a new trigger called {name} to Pulse project {project}.
        slots:
          name: requestBody.name
          project: requestBody.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/triggers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Pulse trigger
      effect: read
      questions:
      - Can I look up one Pulse trigger by id?
      - What are the details of a given trigger?
      instructions:
      - text: Get trigger {id}.
        slots:
          id: path.id
      - text: Show me Pulse trigger {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/triggers/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a Pulse trigger
      effect: write
      questions:
      - Can I fully replace a trigger's name and project with PUT?
      - What must I resend to overwrite a Pulse trigger?
      instructions:
      - text: Replace trigger {id} with name {name} in project {project}.
        slots:
          id: path.id
          name: requestBody.name
          project: requestBody.projectId
      - text: Overwrite trigger {id} so it belongs to project {project}.
        slots:
          id: path.id
          project: requestBody.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/triggers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Pulse trigger
      effect: destructive
      questions:
      - How do I remove a trigger from Pulse?
      - Can I delete one trigger by id?
      instructions:
      - text: Delete trigger {id}.
        slots:
          id: path.id
      - text: Remove Pulse trigger {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/triggers/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch a Pulse trigger
      effect: write
      questions:
      - Can I rename a trigger with a PATCH request?
      - Is there a partial update for a Pulse trigger?
      instructions:
      - text: Patch trigger {id} to rename it {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Partially update trigger {id} with the new name {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'