Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Pebble Files API

3 actions 3 updates phrasing extends openapi/canonical-files-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/files'].get
$.paths['/v1/files'].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 Files API
  version: 1.0.0
extends: openapi/canonical-files-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/files'].get
  update:
    x-apievangelist-phrasing:
      intent: Read or list files
      effect: read
      questions:
      - How do I read a file from the remote system?
      - Can I list a directory filtered by a glob pattern?
      instructions:
      - text: Perform {action} on path {path}.
        slots:
          action: query.action
          path: query.path
      - text: Use action {action} on directory {path} to list entries matching {pattern}.
        slots:
          path: query.path
          pattern: query.pattern
          action: query.action
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/files'].post
  update:
    x-apievangelist-phrasing:
      intent: Write, create or remove files
      effect: write
      questions:
      - Can I upload file contents to a path on the remote system?
      - What's the way to create a directory or remove a file remotely?
      instructions:
      - text: Write these files to the remote system using metadata {request}.
        slots:
          request: requestBody.request
      - text: Upload {files} to the remote system.
        slots:
          files: requestBody.files
      method: generated
      generated: '2026-10-01'