# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for NeoLoad Results API
  version: 1.0.0
extends: openapi/tricentis-results-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: 7
- target: $.paths['/v3/workspaces/{workspaceId}/test-results'].get
  update:
    x-apievangelist-phrasing:
      intent: List test results in a workspace
      effect: read
      questions:
      - What load test results do I have in my NeoLoad Web workspace?
      - Can I filter test results by project or by who launched them?
      - What's the most results I can get per page?
      instructions:
      - text: List test results in workspace {ws}.
        slots:
          ws: path.workspaceId
      - text: List test results in workspace {ws} for project {projectName} launched by {author}.
        slots:
          ws: path.workspaceId
          projectName: query.project
          author: query.author
      - text: Show test results in workspace {ws} with status {status}, sorted by {sort}.
        slots:
          ws: path.workspaceId
          status: query.status
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a test result summary
      effect: read
      questions:
      - How do I see the name, dates and owner of a test result?
      - What's the quality status of a given test result?
      instructions:
      - text: Get test result {result} in workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
      - text: Describe test result {result}.
        slots:
          result: path.resultId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a test result
      effect: destructive
      questions:
      - How do I delete a test result and its statistics?
      - Can a deleted test result be recovered?
      instructions:
      - text: Delete test result {result} from workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
      - text: Permanently remove test result {result} and all its statistics.
        slots:
          result: path.resultId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a test result
      effect: write
      questions:
      - Can I rename a test result or change its description?
      - How do I lock a test result or set its quality status?
      instructions:
      - text: Rename test result {result} in workspace {ws} to {name}.
        slots:
          ws: path.workspaceId
          result: path.resultId
          name: requestBody.name
      - text: Set the quality status of test result {result} to {qualityStatus}.
        slots:
          result: path.resultId
          qualityStatus: requestBody.qualityStatus
      - text: Lock test result {result} by setting locked to {locked}.
        slots:
          result: path.resultId
          locked: requestBody.isLocked
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get logs of a test result
      effect: read
      questions:
      - Where can I see the logs from a load test run?
      - How many log lines does a test result return?
      instructions:
      - text: Get the logs of test result {result} in workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
      - text: Show the first log lines from test result {result}.
        slots:
          result: path.resultId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get main statistics of a test result
      effect: read
      questions:
      - What were the headline statistics of my load test?
      - Can I see live statistics while a test is still running?
      instructions:
      - text: Get the main statistics of test result {result} in workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
      - text: Show live stats for the running test result {result}.
        slots:
          result: path.resultId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/raw'].get
  update:
    x-apievangelist-phrasing:
      intent: Download all raw data of a test result
      effect: read
      questions:
      - Can I export all the raw data of a test result as JSON or CSV?
      - Is the full raw export of a test result a large file?
      instructions:
      - text: Download all raw data for test result {result} in workspace {ws} as {format}.
        slots:
          ws: path.workspaceId
          result: path.resultId
          format: query.format
      - text: Export the complete raw dataset of result {result} in {format}.
        slots:
          result: path.resultId
          format: query.format
      method: generated
      generated: '2026-10-01'