# 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 Log API
  version: 1.0.0
extends: openapi/tricentis-test-log-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: 10
- target: $.paths['/api/v3.1/projects/{projectId}/test-runs/{testRunId}/auto-test-logs'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit automation results for many test runs
      effect: write
      questions:
      - How can I push a batch of automated test results to qTest in one call?
      - Can I submit several automation test logs and get a job ID back to track them?
      instructions:
      - text: Submit this batch of automation test logs for test run {run} in project {project} with type {type}.
        slots:
          project: path.projectId
          run: path.testRunId
          type: query.type
      - text: Upload automation results {logs} to project {project} via test run {run}, type {type}.
        slots:
          project: path.projectId
          run: path.testRunId
          type: query.type
          logs: requestBody.test_logs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/queue-processing/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a batch test log submission job
      effect: read
      questions:
      - Did my batch upload of automation results finish processing?
      - What states can a test log submission job be in, like IN_PROCESSING or FAILED?
      instructions:
      - text: Check the status of test log submission job {job}.
        slots:
          job: path.id
      - text: Tell me whether batch result job {job} succeeded or failed.
        slots:
          job: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/auto-test-logs'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit automation results and build the test tree
      effect: write
      questions:
      - Can I upload automation results and have qTest create the modules, cycles and suites for them?
      - Is there a way to submit test logs with a test design and execution folder structure?
      instructions:
      - text: Submit automation test logs {logs} to project {project} and create the test case and test run tree, type {type}.
        slots:
          logs: requestBody.test_logs
          project: path.projectId
          type: query.type
      - text: Upload results into project {project} under test cycle {cycle} with type {type}, creating missing test runs.
        slots:
          project: path.projectId
          cycle: requestBody.test_cycle
          type: query.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-runs/{testRunId}/auto-test-logs'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit one automation test log
      effect: write
      questions:
      - How do I record the result of a single automated test run?
      - Can I attach a build number and step results to one automation result?
      instructions:
      - text: Log an automation result for test run {run} in project {project} that ran from {start} to {end}.
        slots:
          project: path.projectId
          run: path.testRunId
          start: requestBody.exe_start_date
          end: requestBody.exe_end_date
      - text: Submit status {status} for automated test run {run} in project {project}, started {start}, ended {end}.
        slots:
          project: path.projectId
          run: path.testRunId
          status: requestBody.status
          start: requestBody.exe_start_date
          end: requestBody.exe_end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-runs/{testRunId}/auto-test-logs/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Modify an automation test log
      effect: write
      questions:
      - Can I correct an automation result that was already submitted?
      - How can I change the status on an existing automated test log?
      instructions:
      - text: Update automation test log {log} of test run {run} in project {project} to status {status}.
        slots:
          project: path.projectId
          run: path.testRunId
          log: path.id
          status: requestBody.status
      - text: Fix the start {start} and end {end} times on automation log {log}, test run {run}, project {project}.
        slots:
          project: path.projectId
          run: path.testRunId
          log: path.id
          start: requestBody.exe_start_date
          end: requestBody.exe_end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-runs/{testRunId}/test-logs'].get
  update:
    x-apievangelist-phrasing:
      intent: List all test logs of a test run
      effect: read
      questions:
      - Where can I see the full execution history of a test run?
      - Can I page through every result ever logged against one test run?
      instructions:
      - text: List all test logs for test run {run} in project {project}.
        slots:
          project: path.projectId
          run: path.testRunId
      - text: Show page {page} of the execution history of test run {run}, project {project}.
        slots:
          project: path.projectId
          run: path.testRunId
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-runs/{testRunId}/test-logs'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a manual test log
      effect: write
      questions:
      - How do I record a manual tester's pass or fail result?
      - Can I link defects when logging a manual test run result?
      instructions:
      - text: Log a manual result of {status} for test run {run} in project {project}, from {start} to {end}.
        slots:
          project: path.projectId
          run: path.testRunId
          status: requestBody.status
          start: requestBody.exe_start_date
          end: requestBody.exe_end_date
      - text: Record that manual test run {run} in project {project} failed, executed {start} to {end}.
        slots:
          project: path.projectId
          run: path.testRunId
          start: requestBody.exe_start_date
          end: requestBody.exe_end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-runs/{testRunId}/test-logs/last-run'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the latest result of a test run
      effect: read
      questions:
      - What was the most recent result of this test run?
      - Can I fetch just the last execution of a test run instead of the whole history?
      instructions:
      - text: Get the latest test log of test run {run} in project {project}.
        slots:
          project: path.projectId
          run: path.testRunId
      - text: Show me the last result recorded for test run {run}, project {project}.
        slots:
          project: path.projectId
          run: path.testRunId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-runs/{testRunId}/test-logs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a specific test log
      effect: read
      questions:
      - How can I look up one particular test log by its ID?
      - What details are stored on a single execution result?
      instructions:
      - text: Get test log {log} of test run {run} in project {project}.
        slots:
          project: path.projectId
          run: path.testRunId
          log: path.id
      - text: Show execution record {log} for test run {run}, project {project}.
        slots:
          project: path.projectId
          run: path.testRunId
          log: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/test-runs/{testRunId}/test-logs/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Modify a manual test log
      effect: write
      questions:
      - Can I edit a manual test result after it was submitted?
      - How do I change the note or status on a manual tester's log?
      instructions:
      - text: Update manual test log {log} of test run {run} in project {project} to status {status}.
        slots:
          project: path.projectId
          run: path.testRunId
          log: path.id
          status: requestBody.status
      - text: Edit the note on manual log {log}, test run {run}, project {project}, to {note}.
        slots:
          project: path.projectId
          run: path.testRunId
          log: path.id
          note: requestBody.note
      method: generated
      generated: '2026-10-01'