Checkly · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Checkly Public Test Session Error Groups API

5 actions 5 updates phrasing extends openapi/checkly-test-session-error-groups-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Checkly's API. It is a proposal applied on top of the contract, not a document Checkly publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/v1/test-session-error-groups'].get

$.paths['/v1/test-session-error-groups/projects/{projectId}'].get

$.paths['/v1/test-session-error-groups/{id}'].get

$.paths['/v1/test-session-error-groups/{id}'].patch

OpenAPI Overlay

# 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 Session Error Groups API
  version: 1.0.0
extends: openapi/checkly-test-session-error-groups-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/test-session-error-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List test session error groups
      effect: read
      questions:
      - Which recurring errors show up across my test sessions?
      - Can I page through all test session error groups?
      instructions:
      - text: List all test session error groups.
      - text: Show page {page} of test session error groups, {limit} per page.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test-session-error-groups/projects/{projectId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List test session error groups for a project
      effect: read
      questions:
      - What test session errors is a specific project hitting?
      - Can I narrow test session error groups to one project?
      instructions:
      - text: List test session error groups for project {projectId}.
        slots:
          projectId: path.projectId
      - text: Show the recurring test errors in project {projectId}.
        slots:
          projectId: path.projectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test-session-error-groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a test session error group
      effect: read
      questions:
      - What are the details of one test session error group?
      - Can I look up a single test session error group by ID?
      instructions:
      - text: Show test session error group {id}.
        slots:
          id: path.id
      - text: Get details of test session error group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test-session-error-groups/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Archive a test session error group
      effect: write
      questions:
      - How do I archive a test session error group?
      - Can a test session error group stay archived only until it happens again?
      instructions:
      - text: Archive test session error group {id} forever.
        slots:
          id: path.id
      - text: 'Archive test session error group {id} until the next event: {archivedUntilNextEvent}.'
        slots:
          id: path.id
          archivedUntilNextEvent: requestBody.archivedUntilNextEvent
      method: generated
      generated: '2026-09-26'