# 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 Suite API
  version: 1.0.0
extends: openapi/tricentis-test-suite-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: 5
- target: $.paths['/api/v3/projects/{projectId}/test-suites'].get
  update:
    x-apievangelist-phrasing:
      intent: List test suites under a container
      effect: read
      questions:
      - Which test suites sit under a given test cycle or release?
      - Can I list test suites at the root of a project?
      instructions:
      - text: List the test suites in project {project}.
        slots:
          project: path.projectId
      - text: Show test suites under {parent_type} {parent} in project {project}.
        slots:
          parent_type: query.parentType
          parent: query.parentId
          project: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-suites'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a test suite
      effect: write
      questions:
      - How do I create a test suite inside a test cycle?
      - Can a new test suite target a specific release and build?
      instructions:
      - text: Create test suite {name} in project {project} with properties {properties}.
        slots:
          name: requestBody.name
          project: path.projectId
          properties: requestBody.properties
      - text: Create suite {name} under {parent_type} {parent} in project {project}, properties {properties}.
        slots:
          name: requestBody.name
          parent_type: query.parentType
          parent: query.parentId
          project: path.projectId
          properties: requestBody.properties
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-suites/{testSuiteId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a test suite
      effect: read
      questions:
      - How can I look up one test suite's details?
      - What release and build does a particular test suite target?
      instructions:
      - text: Get test suite {suite} in project {project}.
        slots:
          project: path.projectId
          suite: path.testSuiteId
      - text: Show the details of test suite {suite}, project {project}.
        slots:
          project: path.projectId
          suite: path.testSuiteId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-suites/{testSuiteId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update or move a test suite
      effect: write
      questions:
      - Can I move a test suite to another test cycle?
      - How do I rename a test suite without emailing everyone?
      instructions:
      - text: Rename test suite {suite} in project {project} to {name} with properties {properties}.
        slots:
          project: path.projectId
          suite: path.testSuiteId
          name: requestBody.name
          properties: requestBody.properties
      - text: Move test suite {suite} in project {project} under {parent_type} {parent}.
        slots:
          project: path.projectId
          suite: path.testSuiteId
          parent_type: query.parentType
          parent: query.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-suites/{testSuiteId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a test suite
      effect: destructive
      questions:
      - Can I delete a test suite I no longer need?
      - What's the way to remove a test suite from a project?
      instructions:
      - text: Delete test suite {suite} from project {project}.
        slots:
          project: path.projectId
          suite: path.testSuiteId
      - text: Remove test suite {suite} in project {project} permanently.
        slots:
          project: path.projectId
          suite: path.testSuiteId
      method: generated
      generated: '2026-10-01'