Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snapd REST Root API

3 actions 3 updates phrasing extends openapi/canonical-root-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/users'].get
$.paths['/v2/users'].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 Root API
  version: 1.0.0
extends: openapi/canonical-root-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/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List user accounts on the system
      effect: read
      questions:
      - Which user accounts exist on this system?
      - How do I see the local users on an Ubuntu Core device?
      instructions:
      - text: List the user accounts on the system.
      - text: Show me the local users on this device.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or remove a local user
      effect: write
      questions:
      - How do I create a local user from a store account email?
      - Can I give a new user sudo rights?
      - Can I remove a local user account?
      instructions:
      - text: Create a local user for {email} with sudo {sudoer}.
        slots:
          email: requestBody.email
          sudoer: requestBody.sudoer
      - text: Perform user action {action} on {username}.
        slots:
          action: requestBody.action
          username: requestBody.username
      method: generated
      generated: '2026-09-26'