Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Pebble Exec API

2 actions 2 updates phrasing extends openapi/canonical-exec-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/exec'].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 Exec API
  version: 1.0.0
extends: openapi/canonical-exec-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/exec'].post
  update:
    x-apievangelist-phrasing:
      intent: Execute a command
      effect: write
      questions:
      - How do I run a command inside a Pebble-managed container?
      - Can I run a command as a different user with its own environment variables?
      - Is there a way to get an interactive terminal for a command?
      instructions:
      - text: Run command {command}.
        slots:
          command: requestBody.command
      - text: Execute {command} in working directory {working_dir} with timeout {timeout}.
        slots:
          command: requestBody.command
          working_dir: requestBody.working-dir
          timeout: requestBody.timeout
      - text: Run {command} as user {user} in the context of service {service_context}.
        slots:
          command: requestBody.command
          user: requestBody.user
          service_context: requestBody.service-context
      method: generated
      generated: '2026-10-01'