# 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 results API
  version: 1.0.0
extends: openapi/checkly-check-results-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: 4
- target: $.paths['/v1/check-results/{checkId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a check's raw results (deprecated v1)
      effect: read
      questions:
      - Can I still page through a check's raw results with the older page-numbered endpoint?
      - How long are raw check results kept before they're erased?
      instructions:
      - text: List v1 results for check {checkId}, page {page}.
        slots:
          checkId: path.checkId
          page: query.page
      - text: Using the deprecated v1 results list, show results of check {checkId} run from {location}.
        slots:
          checkId: path.checkId
          location: query.location
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/check-results/{checkId}/{checkResultId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single check result
      effect: read
      questions:
      - What happened in one specific run of a check?
      - Can I see the full detail of a single check result by its ID?
      instructions:
      - text: Show result {checkResultId} of check {checkId}.
        slots:
          checkResultId: path.checkResultId
          checkId: path.checkId
      - text: Get the details of check {checkId} run {checkResultId}.
        slots:
          checkId: path.checkId
          checkResultId: path.checkResultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/check-results/{checkId}/{checkResultId}/assets'].get
  update:
    x-apievangelist-phrasing:
      intent: List downloadable assets of a check result
      effect: read
      questions:
      - Where can I download screenshots or traces from a check run?
      - Can I filter a check result's assets by type or name?
      instructions:
      - text: List assets for result {checkResultId} of check {checkId}.
        slots:
          checkResultId: path.checkResultId
          checkId: path.checkId
      - text: Show {type} assets named {name} from check {checkId} result {checkResultId}.
        slots:
          type: query.type
          name: query.name
          checkId: path.checkId
          checkResultId: path.checkResultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/check-results/{checkId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a check's raw results
      effect: read
      questions:
      - What were the recent results of one of my checks between two dates?
      - Can I list only the failing results of a check from a particular location?
      - Is there a cursor-paged way to list check results with just the fields I need?
      instructions:
      - text: List results for check {checkId} from {from} to {to}.
        slots:
          checkId: path.checkId
          from: query.from
          to: query.to
      - text: Show results of check {checkId} where has failures is {hasFailures}.
        slots:
          checkId: path.checkId
          hasFailures: query.hasFailures
      - text: Get the next {limit} results of check {checkId} after cursor {nextId}.
        slots:
          limit: query.limit
          checkId: path.checkId
          nextId: query.nextId
      method: generated
      generated: '2026-09-26'