Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for qTest Pulse Constant API

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

$.paths['/constants'].post

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

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

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

$.paths['/constants/{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 Constant API
  version: 1.0.0
extends: openapi/tricentis-constant-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['/constants'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's Pulse constants
      effect: read
      questions:
      - Which constants are defined for my Pulse project?
      - Can I page through Pulse constants with first and offset?
      instructions:
      - text: List the constants in project {project}.
        slots:
          project: query.projectId
      - text: Show the first {first} constants of project {project}.
        slots:
          first: query.first
          project: query.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constants'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Pulse constant
      effect: write
      questions:
      - How do I store a reusable value as a Pulse constant?
      - Can I hide a constant's value, for example a secret?
      instructions:
      - text: Create constant {name} with value {value} in project {project}, hidden {hidden}.
        slots:
          name: requestBody.name
          value: requestBody.value
          project: requestBody.projectId
          hidden: requestBody.hidden
      - text: Add a hidden constant called {name} to project {project}.
        slots:
          name: requestBody.name
          project: requestBody.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constants/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Pulse constant
      effect: read
      questions:
      - What value does a given Pulse constant hold?
      - Can I look up one constant by its id?
      instructions:
      - text: Get constant {id}.
        slots:
          id: path.id
      - text: Show me Pulse constant {id} and its value.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constants/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a Pulse constant
      effect: write
      questions:
      - Can I overwrite a constant's name, value and hidden flag in one PUT?
      - What do I resend to fully replace a Pulse constant?
      instructions:
      - text: Replace constant {id} with value {value}.
        slots:
          id: path.id
          value: requestBody.value
      - text: Overwrite constant {id} as {name} in project {project}.
        slots:
          id: path.id
          name: requestBody.name
          project: requestBody.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constants/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Pulse constant
      effect: destructive
      questions:
      - How do I remove a constant from a Pulse project?
      - Can I delete one constant by id?
      instructions:
      - text: Delete constant {id}.
        slots:
          id: path.id
      - text: Remove Pulse constant {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constants/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch a Pulse constant
      effect: write
      questions:
      - Can I change only a constant's value with PATCH?
      - Is there a partial update to unhide a Pulse constant?
      instructions:
      - text: Patch constant {id} so its value is {value}.
        slots:
          id: path.id
          value: requestBody.value
      - text: Partially update constant {id} to set hidden to {hidden}.
        slots:
          id: path.id
          hidden: requestBody.hidden
      method: generated
      generated: '2026-10-01'