# 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 Case API
  version: 1.0.0
extends: openapi/tricentis-test-case-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: 23
- target: $.paths['/api/v3/projects/{projectId}/test-cases'].get
  update:
    x-apievangelist-phrasing:
      intent: List test cases in a project or module
      effect: read
      questions:
      - What test cases are in my qTest project?
      - Can I list only the test cases sitting directly under one module?
      - Is there a way to pull test cases changed since a certain date?
      instructions:
      - text: List all test cases in project {project}.
        slots:
          project: path.projectId
      - text: List test cases directly under module {module} in project {project}, including their steps.
        slots:
          project: path.projectId
          module: query.parentId
      - text: Show test cases in project {project} modified after {since}.
        slots:
          project: path.projectId
          since: query.modifiedAfter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-cases'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a test case
      effect: write
      questions:
      - How do I add a new test case to a qTest project?
      - Can I create a test case inside a specific module with its steps already filled in?
      instructions:
      - text: Create a test case named {name} in project {project}.
        slots:
          project: path.projectId
          name: requestBody.name
      - text: Create test case {name} under module {module} in project {project} with precondition {precondition}.
        slots:
          project: path.projectId
          name: requestBody.name
          module: requestBody.parent_id
          precondition: requestBody.precondition
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-cases/update/testcases'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk update several test cases at once
      effect: write
      questions:
      - Can I update many test cases in one request instead of one at a time?
      - What's the way to bulk edit test cases across a project?
      instructions:
      - text: Bulk update several test cases in project {project} in a single call.
        slots:
          project: path.projectId
      - text: Apply the same batch of edits to multiple test cases in project {project}.
        slots:
          project: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-cases/{idOrKey}/comments'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a test case
      effect: read
      questions:
      - What comments have people left on this test case?
      - Can I page through the discussion on a test case?
      instructions:
      - text: Show all comments on test case {testCase} in project {project}.
        slots:
          project: path.projectId
          testCase: path.idOrKey
      - text: List the first {pageSize} comments on test case {testCase} in project {project}.
        slots:
          project: path.projectId
          testCase: path.idOrKey
          pageSize: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-cases/{idOrKey}/comments'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on a test case
      effect: write
      questions:
      - How do I leave a comment on a test case?
      - Can I post a review note on a test case from a script?
      instructions:
      - text: Add the comment {content} to test case {testCase} in project {project}.
        slots:
          project: path.projectId
          testCase: path.idOrKey
          content: requestBody.content
      - text: Post a note on test case {testCase} in project {project} saying {content}.
        slots:
          project: path.projectId
          testCase: path.idOrKey
          content: requestBody.content
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-cases/{idOrKey}/comments/{commentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one comment on a test case
      effect: read
      questions:
      - How do I read a single comment on a test case by its ID?
      - Who wrote a particular test case comment and when?
      instructions:
      - text: Get comment {comment} on test case {testCase} in project {project}.
        slots:
          project: path.projectId
          testCase: path.idOrKey
          comment: path.commentId
      - text: Show me test case comment {comment} on {testCase}.
        slots:
          testCase: path.idOrKey
          comment: path.commentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-cases/{idOrKey}/comments/{commentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a comment on a test case
      effect: write
      questions:
      - Can I edit a comment I already left on a test case?
      - How do I fix a typo in a test case comment?
      instructions:
      - text: Change comment {comment} on test case {testCase} in project {project} to {content}.
        slots:
          project: path.projectId
          testCase: path.idOrKey
          comment: path.commentId
          content: requestBody.content
      - text: Rewrite the text of test case comment {comment} on {testCase}.
        slots:
          testCase: path.idOrKey
          comment: path.commentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-cases/{idOrKey}/comments/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment from a test case
      effect: destructive
      questions:
      - How do I remove a comment from a test case?
      - Can a test case comment be deleted through the API?
      instructions:
      - text: Delete comment {comment} from test case {testCase} in project {project}.
        slots:
          project: path.projectId
          testCase: path.idOrKey
          comment: path.commentId
      - text: Remove test case comment {comment} on {testCase}.
        slots:
          testCase: path.idOrKey
          comment: path.commentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-cases/{testCaseId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a test case
      effect: read
      questions:
      - How do I fetch a single test case with its details?
      - Can I retrieve an older version of a test case instead of the latest?
      instructions:
      - text: Get test case {testCase} in project {project}.
        slots:
          project: path.projectId
          testCase: path.testCaseId
      - text: Show test case {testCase} in project {project} as it was in version {version}.
        slots:
          project: path.projectId
          testCase: path.testCaseId
          version: query.versionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-cases/{testCaseId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a test case
      effect: write
      questions:
      - How do I change the name or description of an existing test case?
      - Can I move a test case to a different module?
      instructions:
      - text: Rename test case {testCase} in project {project} to {name}.
        slots:
          project: path.projectId
          testCase: path.testCaseId
          name: requestBody.name
      - text: Move test case {testCase} in project {project} under module {module}.
        slots:
          project: path.projectId
          testCase: path.testCaseId
          module: requestBody.parent_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-cases/{testCaseId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a test case
      effect: destructive
      questions:
      - How do I delete a test case from a project?
      - Is deleting a test case something I can automate?
      instructions:
      - text: Delete test case {testCase} from project {project}.
        slots:
          project: path.projectId
          testCase: path.testCaseId
      - text: Permanently remove test case {testCase} in project {project}.
        slots:
          project: path.projectId
          testCase: path.testCaseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-cases/{testCaseId}/approve'].put
  update:
    x-apievangelist-phrasing:
      intent: Approve a test case
      effect: write
      questions:
      - How do I approve a test case so its version becomes official?
      - Can I sign off on a test case through the API?
      instructions:
      - text: Approve test case {testCase} in project {project}.
        slots:
          project: path.projectId
          testCase: path.testCaseId
      - text: Mark test case {testCase} as approved.
        slots:
          testCase: path.testCaseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-cases/{testCaseId}/test-steps'].get
  update:
    x-apievangelist-phrasing:
      intent: List steps of a test case (v3)
      effect: read
      questions:
      - What steps does the latest version of this test case have?
      - Can I see parameter names rather than IDs in test steps?
      instructions:
      - text: List the test steps of test case {testCase} in project {project} using the v3 endpoint.
        slots:
          project: path.projectId
          testCase: path.testCaseId
      - text: Show the current steps of test case {testCase} with parameter identifiers shown.
        slots:
          testCase: path.testCaseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-cases/{testCaseId}/test-steps'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a step to a test case
      effect: write
      questions:
      - How do I add a new step to a test case?
      - Can I add a step that calls another test case?
      instructions:
      - text: 'Add a step to test case {testCase} in project {project}: {description}, expecting {expected}.'
        slots:
          project: path.projectId
          testCase: path.testCaseId
          description: requestBody.description
          expected: requestBody.expected
      - text: Append a step to test case {testCase} that calls test case {calledTestCase}.
        slots:
          testCase: path.testCaseId
          calledTestCase: requestBody.called_test_case_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-cases/{testCaseId}/test-steps/{stepId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one test step
      effect: read
      questions:
      - How do I look up a single step of a test case?
      - What does step 3 of this test case expect?
      instructions:
      - text: Get step {step} of test case {testCase} in project {project}.
        slots:
          project: path.projectId
          testCase: path.testCaseId
          step: path.stepId
      - text: Show the expected result of test step {step} on {testCase}.
        slots:
          testCase: path.testCaseId
          step: path.stepId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-cases/{testCaseId}/test-steps/{stepId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a test step
      effect: write
      questions:
      - Can I change the action or expected result of an existing test step?
      - How do I reorder a test step?
      instructions:
      - text: Update step {step} of test case {testCase} in project {project} to {description} with expected result {expected}.
        slots:
          project: path.projectId
          testCase: path.testCaseId
          step: path.stepId
          description: requestBody.description
          expected: requestBody.expected
      - text: Move test step {step} on {testCase} to position {order}.
        slots:
          testCase: path.testCaseId
          step: path.stepId
          order: requestBody.order
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-cases/{testCaseId}/test-steps/{stepId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a test step
      effect: destructive
      questions:
      - How do I remove a step from a test case?
      - Does deleting a step create a new test case version?
      instructions:
      - text: Delete step {step} from test case {testCase} in project {project}.
        slots:
          project: path.projectId
          testCase: path.testCaseId
          step: path.stepId
      - text: Remove test step {step} on {testCase} without bumping the version.
        slots:
          testCase: path.testCaseId
          step: path.stepId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-cases/{testCaseId}/vera/approve'].put
  update:
    x-apievangelist-phrasing:
      intent: Approve a test case through Vera
      effect: write
      questions:
      - Is there a Vera approval endpoint for test cases?
      - Can a test case be approved via the Vera workflow rather than the standard approval?
      instructions:
      - text: Approve test case {testCase} in project {project} through Vera.
        slots:
          project: path.projectId
          testCase: path.testCaseId
      - text: Run the Vera approval for test case {testCase}.
        slots:
          testCase: path.testCaseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-cases/{testCaseId}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List versions of a test case
      effect: read
      questions:
      - Which versions of this test case exist?
      - Why do I only see major versions plus the latest minor one in a test case's history?
      instructions:
      - text: List all versions of test case {testCase} in project {project}.
        slots:
          project: path.projectId
          testCase: path.testCaseId
      - text: Show the version history for test case {testCase}.
        slots:
          testCase: path.testCaseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-cases/{testCaseId}/versions/{versionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a specific test case version
      effect: read
      questions:
      - How do I fetch one particular version of a test case?
      - Can I see what a test case looked like in version 2.0?
      instructions:
      - text: Get version {version} of test case {testCase} in project {project}.
        slots:
          project: path.projectId
          testCase: path.testCaseId
          version: path.versionId
      - text: Show test case {testCase} at version {version}.
        slots:
          testCase: path.testCaseId
          version: path.versionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-cases/{testCaseId}/versions/{versionId}/test-steps'].get
  update:
    x-apievangelist-phrasing:
      intent: List steps of a test case version (v3)
      effect: read
      questions:
      - How do I get the steps from an older version of a test case?
      - Can I compare steps between two test case versions?
      instructions:
      - text: List the steps of version {version} of test case {testCase} in project {project} using v3.
        slots:
          project: path.projectId
          testCase: path.testCaseId
          version: path.versionId
      - text: Show all steps in test case {testCase} version {version}, unpaged.
        slots:
          testCase: path.testCaseId
          version: path.versionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v4/projects/{projectId}/test-cases/{testCaseId}/test-steps'].get
  update:
    x-apievangelist-phrasing:
      intent: Page through steps of a test case (v4)
      effect: read
      questions:
      - My test case has hundreds of steps; can I page through them?
      - Is there a paginated way to read a test case's latest steps?
      instructions:
      - text: Page through the steps of test case {testCase} in project {project}, {size} per page, via v4.
        slots:
          project: path.projectId
          testCase: path.testCaseId
          size: query.size
      - text: Get page {page} of the latest steps for test case {testCase} using the v4 endpoint.
        slots:
          testCase: path.testCaseId
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v4/projects/{projectId}/test-cases/{testCaseId}/versions/{versionId}/test-steps'].get
  update:
    x-apievangelist-phrasing:
      intent: Page through steps of a test case version (v4)
      effect: read
      questions:
      - Can I paginate the steps of a specific test case version?
      - What's the v4 way to read steps from an older test case version?
      instructions:
      - text: Page through steps of version {version} of test case {testCase} in project {project} via v4.
        slots:
          project: path.projectId
          testCase: path.testCaseId
          version: path.versionId
      - text: Get page {page} of steps for test case {testCase} version {version} using v4.
        slots:
          testCase: path.testCaseId
          version: path.versionId
          page: query.page
      method: generated
      generated: '2026-10-01'