# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Checkly Public Test sessions API
  version: 1.0.0
extends: openapi/checkly-test-sessions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/v1/test-sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List test sessions
      effect: read
      questions:
      - Which test sessions ran recently in my account?
      - Can I filter test sessions by branch, status or who ran them?
      - Is there a way to find test sessions that hit a particular error group?
      instructions:
      - text: List my test sessions.
      - text: Show test sessions on branch {branches} with status {statuses} since {from}.
        slots:
          branches: query.branches
          statuses: query.statuses
          from: query.from
      - text: Find test sessions linked to error group {errorGroupId}.
        slots:
          errorGroupId: query.errorGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test-sessions/trigger'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a test session
      effect: write
      questions:
      - How do I launch a test session against my checks with extra environment variables?
      - Can I attach metadata when starting a test session?
      instructions:
      - text: Run test session {name} in {runLocation}.
        slots:
          name: requestBody.name
          runLocation: requestBody.runLocation
      - text: Launch test session {name} from {runLocation} with environment variables {environmentVariables}.
        slots:
          name: requestBody.name
          runLocation: requestBody.runLocation
          environmentVariables: requestBody.environmentVariables
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test-sessions/{testSessionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a test session
      effect: read
      questions:
      - What's the current state and results of a test session?
      - Can I look at a test session that is still in progress?
      instructions:
      - text: Show test session {testSessionId}.
        slots:
          testSessionId: path.testSessionId
      - text: Get the details of test session {testSessionId}.
        slots:
          testSessionId: path.testSessionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test-sessions/{testSessionId}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running test session
      effect: destructive
      questions:
      - How do I stop a test session that's still running?
      - Can I cancel only certain results within a test session?
      instructions:
      - text: Cancel test session {testSessionId}.
        slots:
          testSessionId: path.testSessionId
      - text: Cancel the runs {sequenceId} in test session {testSessionId}.
        slots:
          sequenceId: requestBody.sequenceId
          testSessionId: path.testSessionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test-sessions/{testSessionId}/completion'].get
  update:
    x-apievangelist-phrasing:
      intent: Wait for a test session to finish
      effect: read
      questions:
      - Can I block until a test session passes or fails?
      - What happens if a test session takes longer than my wait time?
      instructions:
      - text: Wait for test session {testSessionId} to complete.
        slots:
          testSessionId: path.testSessionId
      - text: Wait up to {maxWaitSeconds} seconds for test session {testSessionId} to finish.
        slots:
          maxWaitSeconds: query.maxWaitSeconds
          testSessionId: path.testSessionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test-sessions/{testSessionId}/results/{testSessionResultId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one result from a test session
      effect: read
      questions:
      - What are the details of a single result inside a test session?
      - Does a test session result include references to uploaded assets?
      instructions:
      - text: Show result {testSessionResultId} of test session {testSessionId}.
        slots:
          testSessionResultId: path.testSessionResultId
          testSessionId: path.testSessionId
      - text: Get the detailed data for test session {testSessionId} result {testSessionResultId}.
        slots:
          testSessionId: path.testSessionId
          testSessionResultId: path.testSessionResultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test-sessions/{testSessionId}/results/{testSessionResultId}/assets'].get
  update:
    x-apievangelist-phrasing:
      intent: List downloadable assets of a test session result
      effect: read
      questions:
      - Where can I download the traces, screenshots or videos from a test session result?
      - Can I filter a test session result's assets by type?
      instructions:
      - text: List assets for result {testSessionResultId} in test session {testSessionId}.
        slots:
          testSessionResultId: path.testSessionResultId
          testSessionId: path.testSessionId
      - text: Show {type} assets of test session {testSessionId} result {testSessionResultId}.
        slots:
          type: query.type
          testSessionId: path.testSessionId
          testSessionResultId: path.testSessionResultId
      method: generated
      generated: '2026-09-26'