Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Pebble Services API

3 actions 3 updates phrasing extends openapi/canonical-services-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['/v1/services'].get

$.paths['/v1/services'].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 Services API
  version: 1.0.0
extends: openapi/canonical-services-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['/v1/services'].get
  update:
    x-apievangelist-phrasing:
      intent: List services
      effect: read
      questions:
      - Which Pebble services are running and which are stopped?
      - Can I check the status of just a couple of services?
      instructions:
      - text: List all services and their status.
      - text: Show the status of services {names}.
        slots:
          names: query.names
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/services'].post
  update:
    x-apievangelist-phrasing:
      intent: Start, stop or restart services
      effect: write
      questions:
      - How do I restart a service managed by Pebble?
      - Can I replan so services pick up a new layer?
      instructions:
      - text: Run {action} on services {services}.
        slots:
          action: requestBody.action
          services: requestBody.services
      - text: Restart services {services}.
        slots:
          services: requestBody.services
      method: generated
      generated: '2026-10-01'