API Evangelist conversational phrasing for qTest Manager API Version 3.0 Module 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 Module API
  version: 1.0.0
extends: openapi/tricentis-module-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}/modules'].get
  update:
    x-apievangelist-phrasing:
      intent: List or search modules
      effect: read
      questions:
      - What modules are in my project's test design tree?
      - Can I search for a module by name?
      instructions:
      - text: List top-level modules in project {project}.
        slots:
          project: path.projectId
      - text: Search modules in project {project} named {search}.
        slots:
          project: path.projectId
          search: query.search
      - text: List sub-modules under module {parent} in project {project}.
        slots:
          project: path.projectId
          parent: query.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/modules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a module
      effect: write
      questions:
      - How do I create a folder-like module to organize test cases?
      - Can I create a sub-module under an existing module?
      instructions:
      - text: Create a module named {name} in project {project}.
        slots:
          project: path.projectId
          name: requestBody.name
      - text: Create sub-module {name} under module {parent} in project {project}.
        slots:
          project: path.projectId
          name: requestBody.name
          parent: query.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/modules/{moduleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a module
      effect: read
      questions:
      - How do I fetch one module's details?
      - Can I see a module along with its children?
      instructions:
      - text: Get module {module} in project {project}.
        slots:
          project: path.projectId
          module: path.moduleId
      - text: Show module {module} expanded with its descendants.
        slots:
          module: path.moduleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/modules/{moduleId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update or move a module
      effect: write
      questions:
      - How do I rename a module?
      - Can I move a module under a different parent?
      instructions:
      - text: Rename module {module} in project {project} to {name}.
        slots:
          project: path.projectId
          module: path.moduleId
          name: requestBody.name
      - text: Move module {module} under parent module {parent}.
        slots:
          module: path.moduleId
          parent: query.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/modules/{moduleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a module
      effect: destructive
      questions:
      - How do I delete a module?
      - Can I force-delete a module that still contains test cases?
      instructions:
      - text: Delete module {module} from project {project}.
        slots:
          project: path.projectId
          module: path.moduleId
      - text: Force delete module {module} and everything in it.
        slots:
          module: path.moduleId
      method: generated
      generated: '2026-10-01'