Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Pebble Layers API

2 actions 2 updates phrasing extends openapi/canonical-layers-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/layers'].post

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 Pebble Layers API
  version: 1.0.0
extends: openapi/canonical-layers-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/layers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a layer to the plan
      effect: write
      questions:
      - How do I add a configuration layer to the Pebble plan at runtime?
      - Can a new layer be combined with an existing layer of the same label?
      instructions:
      - text: 'Add layer {label} to the plan with this YAML: {layer}.'
        slots:
          label: requestBody.label
          layer: requestBody.layer
      - text: Combine layer {label} into the plan, combine set to {combine}.
        slots:
          label: requestBody.label
          combine: requestBody.combine
      method: generated
      generated: '2026-10-01'