Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snapd REST Apps API

5 actions 5 updates phrasing extends openapi/canonical-apps-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 5

$.info
$.paths['/v2/aliases'].get
$.paths['/v2/aliases'].post
$.paths['/v2/apps'].get
$.paths['/v2/apps'].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 Snapd REST Apps API
  version: 1.0.0
extends: openapi/canonical-apps-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: 4
- target: $.paths['/v2/aliases'].get
  update:
    x-apievangelist-phrasing:
      intent: List snap app aliases
      effect: read
      questions:
      - Which command aliases are set up for snap apps on this system?
      - What app aliases are available from installed snaps?
      instructions:
      - text: List all snap app aliases.
      - text: Show which aliases point to which snap apps.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/aliases'].post
  update:
    x-apievangelist-phrasing:
      intent: Alias, unalias or prefer snap aliases
      effect: write
      questions:
      - How do I create a command alias for an app inside a snap?
      - Can I remove an alias or make one snap's aliases preferred?
      instructions:
      - text: Alias {app} from snap {snap} as {alias}.
        slots:
          app: requestBody.app
          snap: requestBody.snap
          alias: requestBody.alias
      - text: Perform the {action} action on alias {alias}.
        slots:
          action: requestBody.action
          alias: requestBody.alias
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/apps'].get
  update:
    x-apievangelist-phrasing:
      intent: List apps from installed snaps
      effect: read
      questions:
      - Which applications and services do my installed snaps provide?
      - Can I list only the services from certain snaps?
      instructions:
      - text: List the apps provided by snaps {names}.
        slots:
          names: query.names
      - text: Show only snap services using selection {select}.
        slots:
          select: query.select
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/apps'].post
  update:
    x-apievangelist-phrasing:
      intent: Start, stop or restart snap services
      effect: write
      questions:
      - How do I restart a service that runs from a snap?
      - Can I stop or start snap services through snapd?
      instructions:
      - text: Restart the snap services.
      - text: Stop the selected snap applications.
      method: generated
      generated: '2026-09-26'