# 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 Cycle API
  version: 1.0.0
extends: openapi/tricentis-test-cycle-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-cycles'].get
  update:
    x-apievangelist-phrasing:
      intent: List test cycles
      effect: read
      questions:
      - What test cycles are in my project?
      - Can I list just the test cycles under one release?
      instructions:
      - text: List test cycles at the root of project {project}.
        slots:
          project: path.projectId
      - text: List test cycles 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-cycles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a test cycle
      effect: write
      questions:
      - How do I create a test cycle?
      - Can I create a test cycle under a release and target a build?
      instructions:
      - text: Create a test cycle named {name} in project {project}.
        slots:
          project: path.projectId
          name: requestBody.name
      - text: Create test cycle {name} under release {parent} in project {project}, targeting build {build}.
        slots:
          project: path.projectId
          name: requestBody.name
          parent: query.parentId
          build: requestBody.target_build_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-cycles/{testCycleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a test cycle
      effect: read
      questions:
      - How do I fetch one test cycle?
      - Can I see a test cycle with its child cycles and suites?
      instructions:
      - text: Get test cycle {cycle} in project {project}.
        slots:
          project: path.projectId
          cycle: path.testCycleId
      - text: Show test cycle {cycle} expanded with its descendants.
        slots:
          cycle: path.testCycleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-cycles/{testCycleId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update or move a test cycle
      effect: write
      questions:
      - How do I rename a test cycle?
      - Can I move a test cycle into another release?
      instructions:
      - text: Rename test cycle {cycle} in project {project} to {name}.
        slots:
          project: path.projectId
          cycle: path.testCycleId
          name: requestBody.name
      - text: Move test cycle {cycle} under {parentType} {parent}.
        slots:
          cycle: path.testCycleId
          parentType: query.parentType
          parent: query.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-cycles/{testCycleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a test cycle
      effect: destructive
      questions:
      - How do I delete a test cycle?
      - Can I force-delete a test cycle that still has test runs?
      instructions:
      - text: Delete test cycle {cycle} from project {project}.
        slots:
          project: path.projectId
          cycle: path.testCycleId
      - text: Force delete test cycle {cycle} including its contents.
        slots:
          cycle: path.testCycleId
      method: generated
      generated: '2026-10-01'