# 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 Check sessions API
  version: 1.0.0
extends: openapi/checkly-check-sessions-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/check-sessions/trigger'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger check sessions (v1)
      effect: write
      questions:
      - How do I kick off my checks on demand from CI with the v1 endpoint?
      - Can I trigger only checks matching certain filters using v1?
      instructions:
      - text: Trigger a v1 check session for checks matching {target}.
        slots:
          target: requestBody.target
      - text: Run all eligible checks now via the v1 trigger, refreshing caches {refreshCache}.
        slots:
          refreshCache: requestBody.refreshCache
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/check-sessions/{checkSessionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a check session (v1)
      effect: read
      questions:
      - What results has a v1 check session produced so far?
      - Does a v1 check session show a final result per run location?
      instructions:
      - text: Show v1 check session {checkSessionId}.
        slots:
          checkSessionId: path.checkSessionId
      - text: Get the current v1 results of check session {checkSessionId}.
        slots:
          checkSessionId: path.checkSessionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/check-sessions/{checkSessionId}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running check session
      effect: destructive
      questions:
      - How do I stop a Playwright check suite run that's still in progress?
      - Can I cancel only some parallel runs within a check session?
      instructions:
      - text: Cancel check session {checkSessionId}.
        slots:
          checkSessionId: path.checkSessionId
      - text: Cancel sequences {sequenceId} in check session {checkSessionId}.
        slots:
          sequenceId: requestBody.sequenceId
          checkSessionId: path.checkSessionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/check-sessions/{checkSessionId}/completion'].get
  update:
    x-apievangelist-phrasing:
      intent: Wait for a check session to finish (v1)
      effect: read
      questions:
      - How can my pipeline block until a v1 check session passes or fails?
      - What happens if a v1 check session takes longer than I'm willing to wait?
      instructions:
      - text: Wait for v1 check session {checkSessionId} to complete.
        slots:
          checkSessionId: path.checkSessionId
      - text: Await v1 check session {checkSessionId} for up to {maxWaitSeconds} seconds.
        slots:
          checkSessionId: path.checkSessionId
          maxWaitSeconds: query.maxWaitSeconds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/check-sessions/trigger'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger check sessions (v2)
      effect: write
      questions:
      - How do I trigger check sessions with the newer v2 endpoint?
      - Can the v2 trigger refresh the check cache before running?
      instructions:
      - text: Trigger a v2 check session for checks matching {target}.
        slots:
          target: requestBody.target
      - text: Start v2 check sessions for all eligible checks with cache refresh {refreshCache}.
        slots:
          refreshCache: requestBody.refreshCache
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/check-sessions/{checkSessionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a check session (v2)
      effect: read
      questions:
      - How do I read a check session's results using the v2 endpoint?
      - Can I see in-progress results for a v2 check session?
      instructions:
      - text: Show v2 check session {checkSessionId}.
        slots:
          checkSessionId: path.checkSessionId
      - text: Get the v2 results so far for check session {checkSessionId}.
        slots:
          checkSessionId: path.checkSessionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/check-sessions/{checkSessionId}/completion'].get
  update:
    x-apievangelist-phrasing:
      intent: Wait for a check session to finish (v2)
      effect: read
      questions:
      - Does the v2 completion wait also return when a session is degraded or cancelled?
      - What does the v2 endpoint return if my check session times out while waiting?
      instructions:
      - text: Wait for v2 check session {checkSessionId} to reach a final state.
        slots:
          checkSessionId: path.checkSessionId
      - text: Await v2 check session {checkSessionId}, giving up after {maxWaitSeconds} seconds.
        slots:
          checkSessionId: path.checkSessionId
          maxWaitSeconds: query.maxWaitSeconds
      method: generated
      generated: '2026-09-26'