Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canonical Health API

5 actions 5 updates phrasing extends openapi/canonical-health-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 5

$.info
$.paths['/api/v1/health/'].get
$.paths['/v1/health'].get
$.paths['/health/live'].get
$.paths['/health/ready'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Canonical Health API
  version: 1.0.0
extends: openapi/canonical-health-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: 4
- target: $.paths['/api/v1/health/'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the API health endpoint
      effect: read
      questions:
      - Is the v1 API reporting itself healthy?
      - What does the general health view return?
      instructions:
      - text: Check the v1 API health view.
      - text: Get the overall health status from the API.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Get health of Pebble checks
      effect: read
      questions:
      - Are my Pebble health checks reporting healthy at the ready level?
      - Can I get one healthy-or-not answer for a named set of checks?
      instructions:
      - text: Report the aggregate health of Pebble checks at level {level}.
        slots:
          level: query.level
      - text: Check whether Pebble checks {names} are healthy.
        slots:
          names: query.names
      method: generated
      generated: '2026-10-01'
- target: $.paths['/health/live'].get
  update:
    x-apievangelist-phrasing:
      intent: Run the liveness probe
      effect: read
      questions:
      - Is the application process up and answering requests?
      - Which probe should a container orchestrator use to decide whether to restart the app?
      instructions:
      - text: Run the liveness probe.
      - text: Confirm the process is alive without checking the database.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/health/ready'].get
  update:
    x-apievangelist-phrasing:
      intent: Run the readiness probe
      effect: read
      questions:
      - Is the application ready to serve traffic, including its database connection?
      - Can I verify database connectivity before routing requests to this instance?
      instructions:
      - text: Run the readiness probe.
      - text: Check that the app and its database are ready for traffic.
      method: generated
      generated: '2026-09-26'