Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for qTest Scenario

9 actions 9 updates phrasing extends openapi/tricentis-qtest-scenario-openapi.yaml
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 9

$.info
$.paths['/features'].get
$.paths['/features'].post
$.paths['/features/{id}'].put
$.paths['/features/{id}'].patch
$.paths['/steps'].get
$.paths['/steps'].post
$.paths['/steps/{id}'].put
$.paths['/steps/{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 Scenario
  version: 1.0.0
extends: openapi/tricentis-qtest-scenario-openapi.yaml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/features'].get
  update:
    x-apievangelist-phrasing:
      intent: List BDD feature files
      effect: read
      questions:
      - Which Gherkin feature files are stored in qTest Scenario?
      - Can I find the feature linked to a specific Jira issue key?
      instructions:
      - text: List features linked to issue {issue}.
        slots:
          issue: query.issueKey
      - text: Find features named {name}.
        slots:
          name: query.name
      - text: Find the feature stored in file {filename}.
        slots:
          filename: query.filename
      method: generated
      generated: '2026-10-01'
- target: $.paths['/features'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a BDD feature
      effect: write
      questions:
      - How do I add a new Gherkin feature to qTest Scenario?
      - Can I create a feature file through the API?
      instructions:
      - text: Create feature {feature}.
        slots:
          feature: body.feature
      - text: 'Add a new Gherkin feature with this content: {feature}.'
        slots:
          feature: body.feature
      method: generated
      generated: '2026-10-01'
- target: $.paths['/features/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a BDD feature
      effect: write
      questions:
      - Can I overwrite an entire feature file with new content?
      - What's the way to fully replace a Gherkin feature by ID?
      instructions:
      - text: Replace feature {id} with {feature}.
        slots:
          id: path.id
          feature: body.feature
      - text: Overwrite the whole Gherkin feature {id} using {feature}.
        slots:
          id: path.id
          feature: body.feature
      method: generated
      generated: '2026-10-01'
- target: $.paths['/features/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a BDD feature
      effect: write
      questions:
      - Can I change just part of a feature without resending all of it?
      - Is a partial edit of a Gherkin feature supported?
      instructions:
      - text: Patch feature {id} with {feature}.
        slots:
          id: path.id
          feature: body.feature
      - text: Apply a partial change {feature} to Gherkin feature {id}.
        slots:
          id: path.id
          feature: body.feature
      method: generated
      generated: '2026-10-01'
- target: $.paths['/steps'].get
  update:
    x-apievangelist-phrasing:
      intent: List BDD steps
      effect: read
      questions:
      - Which Given/When/Then steps already exist so I can reuse them?
      - Can I search steps by their text or keyword?
      instructions:
      - text: List steps containing the text {text}.
        slots:
          text: query.text
      - text: Find {keyword} steps linked to issue {issue}.
        slots:
          keyword: query.keyword
          issue: query.issueId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/steps'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a BDD step
      effect: write
      questions:
      - How can I add a new reusable Gherkin step?
      - Can I define a step definition through the API?
      instructions:
      - text: Create step {step}.
        slots:
          step: body.step
      - text: 'Add a new reusable Given/When/Then step: {step}.'
        slots:
          step: body.step
      method: generated
      generated: '2026-10-01'
- target: $.paths['/steps/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a BDD step
      effect: write
      questions:
      - Can I fully replace the definition of an existing step?
      - What's the way to overwrite a step by its ID?
      instructions:
      - text: Replace step {id} with {step}.
        slots:
          id: path.id
          step: body.step
      - text: Overwrite the entire Gherkin step {id} using {step}.
        slots:
          id: path.id
          step: body.step
      method: generated
      generated: '2026-10-01'
- target: $.paths['/steps/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a BDD step
      effect: write
      questions:
      - Can I tweak only some properties of a step?
      - Is there a partial update for Gherkin steps?
      instructions:
      - text: Patch step {id} with {step}.
        slots:
          id: path.id
          step: body.step
      - text: Apply a partial edit {step} to step {id}.
        slots:
          id: path.id
          step: body.step
      method: generated
      generated: '2026-10-01'