Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Pebble Signals API

2 actions 2 updates phrasing extends openapi/canonical-signals-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 2

$.info

$.paths['/v1/signals'].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 Signals API
  version: 1.0.0
extends: openapi/canonical-signals-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: 1
- target: $.paths['/v1/signals'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a signal to services
      effect: write
      questions:
      - How do I send SIGHUP to a service so it reloads its config?
      - Can I signal several services at once?
      instructions:
      - text: Send {signal} to services {services}.
        slots:
          signal: requestBody.signal
          services: requestBody.services
      - text: Signal {services} with {signal}.
        slots:
          services: requestBody.services
          signal: requestBody.signal
      method: generated
      generated: '2026-10-01'