Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Pebble Checks API

4 actions 4 updates phrasing extends openapi/canonical-checks-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/v1/checks'].get

$.paths['/v1/checks'].post

$.paths['/v1/checks/refresh'].post

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 Pebble Checks API
  version: 1.0.0
extends: openapi/canonical-checks-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: 3
- target: $.paths['/v1/checks'].get
  update:
    x-apievangelist-phrasing:
      intent: List health checks
      effect: read
      questions:
      - Which Pebble health checks are failing right now?
      - Can I see only the alive-level or ready-level checks?
      instructions:
      - text: List checks at level {level}.
        slots:
          level: query.level
      - text: Show the details of checks {names}.
        slots:
          names: query.names
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/checks'].post
  update:
    x-apievangelist-phrasing:
      intent: Start or stop health checks
      effect: write
      questions:
      - How do I stop a health check from running?
      - Can I start several checks in one request?
      instructions:
      - text: Run action {action} on checks {checks}.
        slots:
          action: requestBody.action
          checks: requestBody.checks
      - text: Stop checks {checks}.
        slots:
          checks: requestBody.checks
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/checks/refresh'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a health check immediately
      effect: write
      questions:
      - Can I force a check to run now instead of waiting for its period?
      - What does refreshing a single check return?
      instructions:
      - text: Refresh check {name} now.
        slots:
          name: requestBody.name
      - text: Run the {name} check immediately and show the result.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'