# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for NeoLoad Tests API
  version: 1.0.0
extends: openapi/tricentis-tests-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: 6
- target: $.paths['/v3/workspaces/{workspaceId}/tests'].get
  update:
    x-apievangelist-phrasing:
      intent: List tests in a workspace
      effect: read
      questions:
      - What load tests are defined in my workspace?
      - Can I sort tests by when they last ran?
      instructions:
      - text: List the tests in workspace {ws}.
        slots:
          ws: path.workspaceId
      - text: List tests in workspace {ws} sorted by {sort}.
        slots:
          ws: path.workspaceId
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/tests'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a load test
      effect: write
      questions:
      - How do I create a new NeoLoad test?
      - Can I set the controller and load generator zones when creating a test?
      instructions:
      - text: Create a test named {name} in workspace {ws}.
        slots:
          ws: path.workspaceId
          name: requestBody.name
      - text: Create test {name} in workspace {ws} using controller zone {controllerZone} and load generator zones {lgZones}.
        slots:
          ws: path.workspaceId
          name: requestBody.name
          controllerZone: requestBody.controllerZoneId
          lgZones: requestBody.lgZoneIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/tests/{testId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a load test
      effect: read
      questions:
      - How do I see the settings of one test?
      - Which scenario and zones is this test configured with?
      instructions:
      - text: Get test {test} in workspace {ws}.
        slots:
          ws: path.workspaceId
          test: path.testId
      - text: Show the configuration of test {test}.
        slots:
          test: path.testId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/tests/{testId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace all settings of a test
      effect: write
      questions:
      - Can I overwrite every field of a test in one go?
      - How do I fully reconfigure a test's scenario and zones?
      instructions:
      - text: Fully update test {test} in workspace {ws} with name {name} and scenario {scenario}.
        slots:
          ws: path.workspaceId
          test: path.testId
          name: requestBody.name
          scenario: requestBody.scenarioName
      - text: Replace all settings of test {test}.
        slots:
          test: path.testId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/tests/{testId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a load test
      effect: destructive
      questions:
      - How do I delete a test?
      - Can I delete a test's results along with it?
      instructions:
      - text: Delete test {test} from workspace {ws}.
        slots:
          ws: path.workspaceId
          test: path.testId
      - text: Delete test {test} and its results too.
        slots:
          test: path.testId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/tests/{testId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a test
      effect: write
      questions:
      - Can I change just the scenario of a test without touching other settings?
      - How do I rename a test only?
      instructions:
      - text: Change only the scenario of test {test} in workspace {ws} to {scenario}.
        slots:
          ws: path.workspaceId
          test: path.testId
          scenario: requestBody.scenarioName
      - text: Rename test {test} to {name}, leaving everything else as is.
        slots:
          test: path.testId
          name: requestBody.name
      method: generated
      generated: '2026-10-01'