Checkly · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Checkly Public Rocky AI API

4 actions 4 updates phrasing extends openapi/checkly-rocky-ai-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 4

$.info

$.paths['/v1/root-cause-analyses/error-groups/{errorGroupId}'].post

$.paths['/v1/root-cause-analyses/test-session-error-groups/{testSessionErrorGroupId}'].post

$.paths['/v1/root-cause-analyses/{id}'].get

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 Rocky AI API
  version: 1.0.0
extends: openapi/checkly-rocky-ai-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: 3
- target: $.paths['/v1/root-cause-analyses/error-groups/{errorGroupId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a root cause analysis for a check error
      effect: write
      questions:
      - Can AI explain the root cause of a recurring check error?
      - Can I give extra context when asking for a check error group analysis?
      instructions:
      - text: Generate a root cause analysis for error group {errorGroupId}.
        slots:
          errorGroupId: path.errorGroupId
      - text: Analyze the root cause of check error group {errorGroupId} with context {userContext}.
        slots:
          errorGroupId: path.errorGroupId
          userContext: requestBody.userContext
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/root-cause-analyses/test-session-error-groups/{testSessionErrorGroupId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a root cause analysis for a test session error
      effect: write
      questions:
      - Can AI diagnose why a test session keeps failing with the same error?
      - Is the test session error analysis generated asynchronously?
      instructions:
      - text: Generate a root cause analysis for test session error group {testSessionErrorGroupId}.
        slots:
          testSessionErrorGroupId: path.testSessionErrorGroupId
      - text: Diagnose test session error group {testSessionErrorGroupId} using context {userContext}.
        slots:
          testSessionErrorGroupId: path.testSessionErrorGroupId
          userContext: requestBody.userContext
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/root-cause-analyses/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a root cause analysis result
      effect: read
      questions:
      - Is my root cause analysis finished yet, and what did it find?
      - What does a PENDING status mean when polling an analysis?
      instructions:
      - text: Show root cause analysis {id}.
        slots:
          id: path.id
      - text: Poll analysis {id} until it is ready.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'