# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for TTM for Jira Test Runs API
  version: 1.0.0
extends: openapi/tricentis-test-runs-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['/v1/projects/{project-key}/import/execution/junit'].post
  update:
    x-apievangelist-phrasing:
      intent: Import test results from JUnit XML
      effect: write
      questions:
      - How do I import JUnit results as test runs?
      - Can JUnit results be filed under a specific version and cycle?
      instructions:
      - text: Import JUnit results into project {project}.
        slots:
          project: path.project-key
      - text: Import JUnit XML into {project} under version {version} and cycle {cycle}.
        slots:
          project: path.project-key
          version: query.version
          cycle: query.cycleName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{project-key}/test-runs/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search test runs
      effect: read
      questions:
      - Which test runs belong to a given cycle or version?
      - Can I find all runs of particular test cases?
      instructions:
      - text: Find test runs in project {project} for cycles {cycles}.
        slots:
          project: path.project-key
          cycles: requestBody.cycles
      - text: Find runs of test cases {test_cases} in {project}.
        slots:
          test_cases: requestBody.testCasesKeys
          project: path.project-key
      - text: Get test runs {keys} in {project}.
        slots:
          keys: requestBody.keys
          project: path.project-key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{project-key}/test-runs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create test runs
      effect: write
      questions:
      - How do I record new test runs for a release version?
      - Can I copy attachments when creating test runs?
      instructions:
      - text: Create test runs {runs} in project {project}.
        slots:
          runs: requestBody.testRuns
          project: path.project-key
      - text: Create runs in {project} under version {version} and cycle {cycle}.
        slots:
          project: path.project-key
          version: requestBody.version
          cycle: requestBody.cycleName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{project-key}/test-runs/{test-run-key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a test run
      effect: write
      questions:
      - How do I set a test run's status to failed?
      - Can I reassign a test run or move it to another cycle?
      instructions:
      - text: Set test run {test_run} in project {project} to status {status}.
        slots:
          test_run: path.test-run-key
          project: path.project-key
          status: requestBody.status
      - text: Assign run {test_run} in {project} to {assignee}.
        slots:
          test_run: path.test-run-key
          project: path.project-key
          assignee: requestBody.assignee
      - text: Move run {test_run} into cycle {cycle}.
        slots:
          test_run: path.test-run-key
          cycle: requestBody.cycleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{project-key}/test-runs/{test-run-key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a test run
      effect: destructive
      questions:
      - What removes a test run entirely?
      - Can I remove a run I created by mistake?
      instructions:
      - text: Delete test run {test_run} in project {project}.
        slots:
          test_run: path.test-run-key
          project: path.project-key
      - text: Remove run {test_run} permanently.
        slots:
          test_run: path.test-run-key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/testruns'].get
  update:
    x-apievangelist-phrasing:
      intent: List test runs in the analytics feed
      effect: read
      questions:
      - Which test runs are in the test analytics data?
      - Can I order analytics test runs by a property?
      instructions:
      - text: List analytics test runs.
      - text: List analytics test runs matching {filter}.
        slots:
          filter: query.$filter
      - text: Show analytics test runs ordered by {orderby}.
        slots:
          orderby: query.$orderby
      method: generated
      generated: '2026-10-01'
- target: $.paths['/testruns({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an analytics test run by key
      effect: read
      questions:
      - Where do I read one test run record from the analytics feed?
      - Can I return only some fields of an analytics test run?
      instructions:
      - text: Get analytics test run {id}.
        slots:
          id: path.id
      - text: Show only {select} of analytics test run {id}.
        slots:
          select: query.$select
          id: path.id
      method: generated
      generated: '2026-10-01'