Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snapd REST Interfaces API

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

$.paths['/v2/interfaces'].get

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 Snapd REST Interfaces API
  version: 1.0.0
extends: openapi/canonical-interfaces-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/v2/connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List interface connections
      effect: read
      questions:
      - Which plugs and slots are currently connected on this system?
      - Can I see the interface connections for just one snap?
      instructions:
      - text: Show all interface connections.
      - text: List connections for snap {snap} on interface {interface}.
        slots:
          snap: query.snap
          interface: query.interface
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/interfaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List available interfaces
      effect: read
      questions:
      - What snap interfaces are available on this device?
      - Can I get the documentation and plugs for specific interfaces?
      instructions:
      - text: List the available interfaces.
      - text: Describe interfaces {names} including docs {doc} and plugs {plugs}.
        slots:
          names: query.names
          doc: query.doc
          plugs: query.plugs
      method: generated
      generated: '2026-09-26'