Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for qTest Pulse Rule API

7 actions 7 updates phrasing extends openapi/tricentis-rule-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['/rules'].get

$.paths['/rules'].post

$.paths['/rules/{id}'].get

$.paths['/rules/{id}'].put

$.paths['/rules/{id}'].delete

$.paths['/rules/{id}'].patch

OpenAPI Overlay

# 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 Rule API
  version: 1.0.0
extends: openapi/tricentis-rule-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['/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's Pulse rules
      effect: read
      questions:
      - Which automation rules are set up in my Pulse project?
      - Can I page through Pulse rules with an offset?
      instructions:
      - text: List the rules in project {project}.
        slots:
          project: query.projectId
      - text: Show the first {first} rules of project {project}.
        slots:
          first: query.first
          project: query.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Pulse rule
      effect: write
      questions:
      - How do I create a rule that runs actions when a trigger fires?
      - Can a new Pulse rule be created inactive?
      instructions:
      - text: Create rule {name} in project {project} with active {active}.
        slots:
          name: requestBody.name
          project: requestBody.projectId
          active: requestBody.active
      - text: Create an active rule {name} in {project} linking trigger {trigger} to actions {actions}.
        slots:
          name: requestBody.name
          project: requestBody.projectId
          trigger: requestBody.triggerId
          actions: requestBody.actionIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rules/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Pulse rule
      effect: read
      questions:
      - Which trigger and actions does a given rule use?
      - Can I look up one Pulse rule by id?
      instructions:
      - text: Get rule {id}.
        slots:
          id: path.id
      - text: Show the trigger and actions of rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rules/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a Pulse rule
      effect: write
      questions:
      - Can I fully replace a rule's trigger and actions with PUT?
      - What must I resend to overwrite a Pulse rule?
      instructions:
      - text: Replace rule {id} with name {name}, active {active}, in project {project}.
        slots:
          id: path.id
          name: requestBody.name
          active: requestBody.active
          project: requestBody.projectId
      - text: Overwrite rule {id} so it uses trigger {trigger}.
        slots:
          id: path.id
          trigger: requestBody.triggerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rules/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Pulse rule
      effect: destructive
      questions:
      - How do I remove an automation rule from Pulse?
      - Can I delete one rule by id?
      instructions:
      - text: Delete rule {id}.
        slots:
          id: path.id
      - text: Remove Pulse rule {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rules/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch a Pulse rule
      effect: write
      questions:
      - Can I just switch a rule off with PATCH?
      - Is there a partial update to change a rule's actions?
      instructions:
      - text: Patch rule {id} to set active to {active}.
        slots:
          id: path.id
          active: requestBody.active
      - text: Partially update rule {id} to run actions {actions}.
        slots:
          id: path.id
          actions: requestBody.actionIds
      method: generated
      generated: '2026-10-01'