# 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 Open Access API
  version: 1.0.0
extends: openapi/canonical-open-access-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: 10
- target: $.paths['/v2/icons/{name}/icon'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an installed snap's icon
      effect: read
      questions:
      - Can I fetch the icon file of a snap installed on this machine?
      - Where does snapd serve the raw icon for an installed snap?
      instructions:
      - text: Get the icon of the installed snap {name}.
        slots:
          name: path.name
      - text: Download the icon file for snap {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/quotas'].get
  update:
    x-apievangelist-phrasing:
      intent: List snap quota groups
      effect: read
      questions:
      - Which quota groups exist on this system and what limits do they set?
      - What resource constraints are applied to snaps via quota groups?
      instructions:
      - text: List all snap quota groups and their constraints.
      - text: Show every quota group on this device.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/quotas/{group-name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one snap quota group
      effect: read
      questions:
      - What limits does a particular quota group enforce?
      - Can I look up a single quota group by its name?
      instructions:
      - text: Show the quota group {group}.
        slots:
          group: path.group-name
      - text: Get the constraints of quota group {group}.
        slots:
          group: path.group-name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/sections'].get
  update:
    x-apievangelist-phrasing:
      intent: List Snap Store sections
      effect: read
      questions:
      - Which sections or categories are available in the Snap Store?
      - What store sections can I browse snaps by?
      instructions:
      - text: List the Snap Store sections.
      - text: Show the available store categories.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/snaps'].get
  update:
    x-apievangelist-phrasing:
      intent: List installed snaps
      effect: read
      questions:
      - Which snaps are installed on this system, with their components?
      - Can I list only some installed snaps by name?
      instructions:
      - text: List all installed snaps.
      - text: Show installed snaps {snaps}.
        slots:
          snaps: query.snaps
      - text: List installed snaps using selection {select}.
        slots:
          select: query.select
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/snaps/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of an installed snap
      effect: read
      questions:
      - What version and channel is a specific installed snap on?
      - Can I see the details of one snap installed on this machine?
      instructions:
      - text: Show details for the installed snap {name}.
        slots:
          name: path.name
      - text: Get the version and revision of snap {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/snapshots'].get
  update:
    x-apievangelist-phrasing:
      intent: List snap snapshots
      effect: read
      questions:
      - Which snapshot sets of snap data are stored on this system?
      - Can I see the metadata of all saved snapshots?
      instructions:
      - text: List all stored snapshot sets.
      - text: Show metadata for every snap snapshot on this machine.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/systems'].get
  update:
    x-apievangelist-phrasing:
      intent: List recovery systems
      effect: read
      questions:
      - Which recovery systems are available on this device?
      - Can I see the Ubuntu Core recovery systems I could boot into?
      instructions:
      - text: List the available recovery systems.
      - text: Show every recovery system on this device.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/system-info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get snapd system information
      effect: read
      questions:
      - What version of snapd is running and how is the server configured?
      - Where can I see snapd's environment and configuration info?
      instructions:
      - text: Show snapd system information.
      - text: Get the server configuration and environment details from snapd.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/warnings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get snapd warnings
      effect: read
      questions:
      - Are there any current warnings from snapd?
      - Can I list all warnings, including ones already shown?
      instructions:
      - text: Show the current snapd warnings.
      - text: List snapd warnings using selection {select}.
        slots:
          select: query.select
      method: generated
      generated: '2026-10-01'