# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure Test Run API
  version: 1.0.0
extends: openapi/microsoft-azure-test-run-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: 22
- target: $.paths['/test-runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List load test runs with filters
      effect: read
      questions:
      - Which load test runs have I executed for a particular test?
      - Can I filter my load test runs by status and an execution date range?
      - What test runs ran between two dates, sorted by newest first?
      instructions:
      - text: List the load test runs for test {testId}.
        slots:
          testId: query.testId
      - text: Show test runs with status {status} executed between {executionFrom} and {executionTo}.
        slots:
          status: query.status
          executionFrom: query.executionFrom
          executionTo: query.executionTo
      - text: Search my load test runs for {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-10-01'
- target: $.paths['/test-runs/{testRunId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a load test run's details
      effect: read
      questions:
      - What were the results and status of a specific load test run?
      - Can I pull up the full details of one test run by its id?
      instructions:
      - text: Show the details of load test run {testRunId}.
        slots:
          testRunId: path.testRunId
      - text: Get test run {testRunId} and tell me its current status.
        slots:
          testRunId: path.testRunId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/test-runs/{testRunId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a load test run
      effect: destructive
      questions:
      - How do I get rid of an old load test run I no longer need?
      - Can a finished test run be deleted from Azure Load Testing?
      instructions:
      - text: Delete load test run {testRunId}.
        slots:
          testRunId: path.testRunId
      - text: Remove the test run {testRunId} and its results permanently.
        slots:
          testRunId: path.testRunId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/test-runs/{testRunId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Start a new load test run
      effect: write
      questions:
      - How do I kick off a new run of an existing load test?
      - Can I rerun a load test using the settings from a previous run?
      - Is it possible to set pass/fail and auto-stop criteria when I start a run?
      instructions:
      - text: Start test run {testRunId} for load test {testId}.
        slots:
          testRunId: path.testRunId
          testId: requestBody.testId
      - text: Rerun test run {oldTestRunId} as new run {testRunId}.
        slots:
          oldTestRunId: query.oldTestRunId
          testRunId: path.testRunId
      - text: Start run {testRunId} named {displayName} with auto-stop criteria {autoStopCriteria}.
        slots:
          testRunId: path.testRunId
          displayName: requestBody.displayName
          autoStopCriteria: requestBody.autoStopCriteria
      method: generated
      generated: '2026-10-01'
- target: $.paths['/test-runs/{testRunId}:stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a running load test
      effect: destructive
      questions:
      - How can I halt a load test run that's currently executing?
      - Can I abort a test run early if it's hammering my app too hard?
      instructions:
      - text: Stop load test run {testRunId} now.
        slots:
          testRunId: path.testRunId
      - text: Abort the in-progress test run {testRunId}.
        slots:
          testRunId: path.testRunId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/test-runs/{testRunId}/app-components'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the app components tied to a test run
      effect: read
      questions:
      - Which Azure resources are being monitored as app components for a test run?
      - What app components are associated with a given load test run?
      instructions:
      - text: Show the app components linked to test run {testRunId}.
        slots:
          testRunId: path.testRunId
      - text: List the Azure resources monitored during load test run {testRunId}.
        slots:
          testRunId: path.testRunId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/test-runs/{testRunId}/app-components'].patch
  update:
    x-apievangelist-phrasing:
      intent: Add app components to a test run
      effect: write
      questions:
      - How do I attach an Azure resource as an app component to a load test run?
      - Can I add monitored app components to a run by resource id, name and type?
      instructions:
      - text: Add app components {components} to test run {testRunId}.
        slots:
          components: requestBody.components
          testRunId: path.testRunId
      - text: Attach these Azure resources {components} for monitoring on load test run {testRunId}.
        slots:
          components: requestBody.components
          testRunId: path.testRunId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/test-runs/{testRunId}/files/{fileName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a file from a load test run
      effect: read
      questions:
      - How do I retrieve a results or log file from a load test run by name?
      - Can I fetch a specific file produced by a test run?
      instructions:
      - text: Get file {fileName} from load test run {testRunId}.
        slots:
          fileName: path.fileName
          testRunId: path.testRunId
      - text: Download the run artifact named {fileName} for test run {testRunId}.
        slots:
          fileName: path.fileName
          testRunId: path.testRunId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/test-runs/{testRunId}/metric-definitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List metric definitions for a test run
      effect: read
      questions:
      - Which metrics can I query for a load test run within a namespace?
      - What metric definitions are available for a given run and metric namespace?
      instructions:
      - text: List metric definitions for test run {testRunId} in namespace {metricNamespace}.
        slots:
          testRunId: path.testRunId
          metricNamespace: query.metricNamespace
      - text: Show which metrics I can chart for run {testRunId} under {metricNamespace}.
        slots:
          testRunId: path.testRunId
          metricNamespace: query.metricNamespace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/test-runs/{testRunId}/metric-dimensions/{name}/values'].get
  update:
    x-apievangelist-phrasing:
      intent: List values of a metric dimension for a test run
      effect: read
      questions:
      - What values does a metric dimension take during a load test run?
      - Can I see the distinct dimension values for a metric over a time span?
      instructions:
      - text: List values of dimension {name} for metric {metricname} in namespace {metricNamespace} on run {testRunId} over {timespan}.
        slots:
          name: path.name
          metricname: query.metricname
          metricNamespace: query.metricNamespace
          testRunId: path.testRunId
          timespan: query.timespan
      - text: Show the dimension values for {name} on test run {testRunId}.
        slots:
          name: path.name
          testRunId: path.testRunId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/test-runs/{testRunId}/metric-namespaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List metric namespaces for a test run
      effect: read
      questions:
      - Which metric namespaces does a load test run expose?
      - What groups of metrics were collected for one test run?
      instructions:
      - text: List the metric namespaces for test run {testRunId}.
        slots:
          testRunId: path.testRunId
      - text: Show which metric namespaces are available on load test run {testRunId}.
        slots:
          testRunId: path.testRunId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/test-runs/{testRunId}/metrics'].post
  update:
    x-apievangelist-phrasing:
      intent: Get metric values for a load test run
      effect: read
      questions:
      - What were the response time values for a load test run over time?
      - Can I aggregate a test run metric by interval and filter by dimension?
      instructions:
      - text: Get values of metric {metricname} in namespace {metricNamespace} for run {testRunId} over {timespan}.
        slots:
          metricname: query.metricname
          metricNamespace: query.metricNamespace
          testRunId: path.testRunId
          timespan: query.timespan
      - text: Chart metric {metricname} for test run {testRunId} with {aggregation} aggregation at {interval} intervals.
        slots:
          metricname: query.metricname
          testRunId: path.testRunId
          aggregation: query.aggregation
          interval: query.interval
      method: generated
      generated: '2026-10-01'
- target: $.paths['/test-runs/{testRunId}/server-metrics-config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get server metrics configuration for a test run
      effect: read
      questions:
      - Which server-side metrics are configured for a load test run?
      - What resource metrics will be captured from my app during a run?
      instructions:
      - text: Show the server metrics configuration for test run {testRunId}.
        slots:
          testRunId: path.testRunId
      - text: Get the server-side metrics set up on load test run {testRunId}.
        slots:
          testRunId: path.testRunId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/test-runs/{testRunId}/server-metrics-config'].patch
  update:
    x-apievangelist-phrasing:
      intent: Configure server metrics for a test run
      effect: write
      questions:
      - How do I choose which server metrics to collect during a load test run?
      - Can I change the server-side metrics captured for a specific run?
      instructions:
      - text: Configure server metrics {metrics} for test run {testRunId}.
        slots:
          metrics: requestBody.metrics
          testRunId: path.testRunId
      - text: Set the server-side metrics collected on load test run {testRunId} to {metrics}.
        slots:
          testRunId: path.testRunId
          metrics: requestBody.metrics
      method: generated
      generated: '2026-10-01'
- target: $.paths['/testruns/{testRunId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a test run via the legacy testruns endpoint
      effect: read
      questions:
      - How do I read a test run through the older /testruns endpoint?
      - Can the legacy load testing API still return a test run by name?
      instructions:
      - text: Get test run {testRunId} using the legacy testruns endpoint.
        slots:
          testRunId: path.testRunId
      - text: Fetch run {testRunId} from the older load testing API version.
        slots:
          testRunId: path.testRunId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/testruns/{testRunId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a test run via the legacy endpoint
      effect: destructive
      questions:
      - How do I delete a test run with the older /testruns API?
      - What characters are allowed in a test run name when deleting through the legacy endpoint?
      instructions:
      - text: Delete test run {testRunId} using the legacy testruns endpoint.
        slots:
          testRunId: path.testRunId
      - text: Remove run {testRunId} through the older load testing API version.
        slots:
          testRunId: path.testRunId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/testruns/{testRunId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Start a test run via the legacy endpoint
      effect: write
      questions:
      - How do I start a new test run with the older /testruns API?
      - Can the legacy endpoint rerun a test from an earlier run's settings?
      instructions:
      - text: Start test run {testRunId} for test {testId} using the legacy testruns endpoint.
        slots:
          testRunId: path.testRunId
          testId: requestBody.testId
      - text: Through the older API, rerun {oldTestRunId} as new run {testRunId}.
        slots:
          oldTestRunId: query.oldTestRunId
          testRunId: path.testRunId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/testruns/{testRunId}/files/{fileId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a test run file via the legacy endpoint
      effect: read
      questions:
      - How do I fetch a test run file by file id with the older /testruns API?
      - Can the legacy endpoint return a run's files?
      instructions:
      - text: Get file {fileId} from test run {testRunId} using the legacy testruns endpoint.
        slots:
          fileId: path.fileId
          testRunId: path.testRunId
      - text: Download legacy run file {fileId} for {testRunId}.
        slots:
          fileId: path.fileId
          testRunId: path.testRunId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/testruns/sortAndFilter'].get
  update:
    x-apievangelist-phrasing:
      intent: Search test runs via the legacy sortAndFilter endpoint
      effect: read
      questions:
      - How do I sort and filter test runs with the older sortAndFilter API?
      - Can the legacy endpoint page through test runs with a next link?
      instructions:
      - text: Using the legacy sortAndFilter endpoint, list test runs for test {testId}.
        slots:
          testId: query.testId
      - text: Through the older API, find runs matching {search} ordered by {orderBy}.
        slots:
          search: query.search
          orderBy: query.orderBy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/testruns/{testRunId}:stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a test run via the legacy endpoint
      effect: destructive
      questions:
      - How do I stop a running test with the older /testruns API?
      - Does the legacy load testing endpoint support stopping a run?
      instructions:
      - text: Stop test run {testRunId} using the legacy testruns endpoint.
        slots:
          testRunId: path.testRunId
      - text: Halt run {testRunId} through the older load testing API version.
        slots:
          testRunId: path.testRunId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/testruns/{testRunId}/clientMetrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get client-side metrics for a load test run
      effect: read
      questions:
      - What client-side metrics did a load test run record?
      - Can I group a run's client metrics by time interval?
      instructions:
      - text: Get client metrics for test run {testRunId}.
        slots:
          testRunId: path.testRunId
      - text: Show client metrics for run {testRunId} grouped by {groupByInterval}.
        slots:
          testRunId: path.testRunId
          groupByInterval: query.groupByInterval
      method: generated
      generated: '2026-10-01'
- target: $.paths['/testruns/{testRunId}/clientMetricsFilters'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported client metric filters for a run
      effect: read
      questions:
      - Which filters can I apply to a test run's client metrics?
      - What values can I use to narrow down a load test run's client metrics?
      instructions:
      - text: List the supported client metric filters for test run {testRunId}.
        slots:
          testRunId: path.testRunId
      - text: Show what I can filter client metrics by on run {testRunId}.
        slots:
          testRunId: path.testRunId
      method: generated
      generated: '2026-10-01'