API Evangelist conversational phrasing for qTest Manager API Version 3.0 Test Run API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for qTest Manager API Version 3.0 Test Run API
  version: 1.0.0
extends: openapi/tricentis-test-run-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: 15
- target: $.paths['/api/v3/projects/{projectId}/test-runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List test runs in a project or container
      effect: read
      questions:
      - What test runs are in my project?
      - Can I list the test runs inside one test cycle or test suite?
      - Is there a page size limit when listing test runs?
      instructions:
      - text: List all test runs in project {project}.
        slots:
          project: path.projectId
      - text: List test runs under {parentType} {parent} in project {project}.
        slots:
          project: path.projectId
          parentType: query.parentType
          parent: query.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-runs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a test run for a test case
      effect: write
      questions:
      - How do I schedule a single test case for execution as a test run?
      - Can I create a test run inside a specific test cycle?
      instructions:
      - text: Create a test run for test case {testCase} in project {project}.
        slots:
          project: path.projectId
          testCase: requestBody.test_case
      - text: Add a test run named {name} for test case {testCase} under test cycle {parent}.
        slots:
          name: requestBody.name
          testCase: requestBody.test_case
          parent: query.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-runs/assign-parameter-values/dataset'].post
  update:
    x-apievangelist-phrasing:
      intent: Create test runs from a parameter dataset
      effect: write
      questions:
      - Can I generate test runs from rows in a parameter dataset?
      - How many test runs can I create from a dataset at once?
      instructions:
      - text: Create test runs for test case {testCase} in project {project} from dataset {dataset}.
        slots:
          project: path.projectId
          testCase: requestBody.test_case
          dataset: requestBody.dataset_id
      - text: Generate {rows} test runs for {testCase} starting at row {fromRow} of dataset {dataset}.
        slots:
          rows: requestBody.number_of_rows
          testCase: requestBody.test_case
          fromRow: requestBody.from_row
          dataset: requestBody.dataset_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-runs/assign-parameter-values/manually'].post
  update:
    x-apievangelist-phrasing:
      intent: Create test runs with hand-picked parameter values
      effect: write
      questions:
      - How do I create several test runs where I choose each run's parameter values myself?
      - What's the maximum number of manually parameterized test runs per request?
      instructions:
      - text: 'Create test runs for test case {testCase} in project {project} with these manual parameter values: {runs}.'
        slots:
          project: path.projectId
          testCase: requestBody.test_case
          runs: requestBody.test_runs
      - text: Manually assign parameter values {runs} to new runs of {testCase}.
        slots:
          testCase: requestBody.test_case
          runs: requestBody.test_runs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-runs/assign-parameter-values/randomize'].post
  update:
    x-apievangelist-phrasing:
      intent: Create test runs with random parameter combinations
      effect: write
      questions:
      - Can qTest randomly combine parameter values into multiple test runs?
      - How do I cap the number of random parameter combinations?
      instructions:
      - text: Create test runs for {testCase} in project {project} using combine type {combineType}.
        slots:
          project: path.projectId
          testCase: requestBody.test_case
          combineType: requestBody.combined_type
      - text: Generate {count} random parameter combinations as test runs for {testCase} with combine type {combineType}.
        slots:
          count: requestBody.number_of_combinations
          testCase: requestBody.test_case
          combineType: requestBody.combined_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-runs/execution-statuses'].get
  update:
    x-apievangelist-phrasing:
      intent: List test run execution statuses
      effect: read
      questions:
      - What execution statuses can a test run have in my project?
      - Which status values like Passed or Failed are configured?
      instructions:
      - text: List the test run execution statuses for project {project}.
        slots:
          project: path.projectId
      - text: Show the allowed run statuses in project {project}.
        slots:
          project: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-runs/subhierarchy'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the test execution tree under a container
      effect: read
      questions:
      - How do I see the full tree of cycles and suites under a release?
      - Can I get the whole sub-hierarchy of the test execution area?
      instructions:
      - text: Show the sub-hierarchy under {parentType} {parent} in project {project}.
        slots:
          project: path.projectId
          parentType: query.parentType
          parent: query.parentId
      - text: Get the full test execution tree from root in project {project}.
        slots:
          project: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-runs/{idOrKey}/comments'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a test run
      effect: read
      questions:
      - What comments are on this test run?
      - Can I read the notes testers left on a run?
      instructions:
      - text: Show all comments on test run {testRun} in project {project}.
        slots:
          project: path.projectId
          testRun: path.idOrKey
      - text: List tester notes on test run {testRun}.
        slots:
          testRun: path.idOrKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-runs/{idOrKey}/comments'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on a test run
      effect: write
      questions:
      - How do I add a comment to a test run?
      - Can I post execution notes on a run automatically?
      instructions:
      - text: Add the comment {content} to test run {testRun} in project {project}.
        slots:
          project: path.projectId
          testRun: path.idOrKey
          content: requestBody.content
      - text: 'Post an execution note on test run {testRun}: {content}.'
        slots:
          testRun: path.idOrKey
          content: requestBody.content
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-runs/{idOrKey}/comments/{commentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one comment on a test run
      effect: read
      questions:
      - How do I fetch a specific comment on a test run?
      - Who posted a given test run comment?
      instructions:
      - text: Get comment {comment} on test run {testRun} in project {project}.
        slots:
          project: path.projectId
          testRun: path.idOrKey
          comment: path.commentId
      - text: Show test run comment {comment} on {testRun}.
        slots:
          testRun: path.idOrKey
          comment: path.commentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-runs/{idOrKey}/comments/{commentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a comment on a test run
      effect: write
      questions:
      - Can I change a comment already posted on a test run?
      - How do I correct a test run note?
      instructions:
      - text: Change comment {comment} on test run {testRun} in project {project} to {content}.
        slots:
          project: path.projectId
          testRun: path.idOrKey
          comment: path.commentId
          content: requestBody.content
      - text: Edit test run comment {comment} on {testRun}.
        slots:
          testRun: path.idOrKey
          comment: path.commentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-runs/{idOrKey}/comments/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment from a test run
      effect: destructive
      questions:
      - How do I remove a comment from a test run?
      - Can test run comments be deleted?
      instructions:
      - text: Delete comment {comment} from test run {testRun} in project {project}.
        slots:
          project: path.projectId
          testRun: path.idOrKey
          comment: path.commentId
      - text: Remove test run comment {comment} on {testRun}.
        slots:
          testRun: path.idOrKey
          comment: path.commentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-runs/{testRunId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a test run
      effect: read
      questions:
      - How do I look up a single test run?
      - Can I include Tosca properties when fetching a test run?
      instructions:
      - text: Get test run {testRun} in project {project}.
        slots:
          project: path.projectId
          testRun: path.testRunId
      - text: Show test run {testRun} with its Tosca properties.
        slots:
          testRun: path.testRunId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-runs/{testRunId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update or move a test run
      effect: write
      questions:
      - How do I rename a test run?
      - Can I move a test run to a different test cycle or suite?
      instructions:
      - text: Rename test run {testRun} in project {project} to {name}.
        slots:
          project: path.projectId
          testRun: path.testRunId
          name: requestBody.name
      - text: Move test run {testRun} into {parentType} {parent}.
        slots:
          testRun: path.testRunId
          parentType: query.parentType
          parent: query.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-runs/{testRunId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a test run
      effect: destructive
      questions:
      - How do I delete a test run?
      - Can I remove a test run I created by mistake?
      instructions:
      - text: Delete test run {testRun} from project {project}.
        slots:
          project: path.projectId
          testRun: path.testRunId
      - text: Remove the mistaken test run {testRun}.
        slots:
          testRun: path.testRunId
      method: generated
      generated: '2026-10-01'