Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canonical Metrics API

3 actions 3 updates phrasing extends openapi/canonical-metrics-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 3

$.info

$.paths['/1.0/metrics'].get

$.paths['/v1/metrics'].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 Canonical Metrics API
  version: 1.0.0
extends: openapi/canonical-metrics-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: 2
- target: $.paths['/1.0/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get instance metrics
      effect: read
      questions:
      - How much CPU and memory are my instances using?
      - Can I pull instance metrics from just one cluster member?
      instructions:
      - text: Get metrics for instances in project {project}.
        slots:
          project: query.project
      - text: Fetch instance metrics from cluster member {target}.
        slots:
          target: query.target
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Pebble service and check metrics
      effect: read
      questions:
      - Can I scrape Pebble service and health check metrics in OpenMetrics format?
      - How many times has a Pebble service restarted, according to its metrics?
      instructions:
      - text: Get the Pebble services and checks metrics.
      - text: Export Pebble metrics in OpenMetrics format.
      method: generated
      generated: '2026-10-01'