Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canonical Permissions API

4 actions 4 updates phrasing extends openapi/canonical-permissions-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 4

$.info

$.paths['/1.0/auth/permissions'].get

$.paths['/1.0/auth/permissions?recursion=1'].get

$.paths['/v1/permissions'].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 Canonical Permissions API
  version: 1.0.0
extends: openapi/canonical-permissions-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: 3
- target: $.paths['/1.0/auth/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List available LXD permissions
      effect: read
      questions:
      - Which permissions can I grant on LXD entities?
      - Can I list only the permissions for one entity type?
      instructions:
      - text: List available permissions for entity type {entityType}.
        slots:
          entityType: query.entityType
      - text: Show the permissions available in project {project}.
        slots:
          project: query.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1.0/auth/permissions?recursion=1'].get
  update:
    x-apievangelist-phrasing:
      intent: List LXD permissions with the groups holding them
      effect: read
      questions:
      - Which groups hold each LXD permission?
      - How do I see who has been granted a permission on an entity type?
      instructions:
      - text: List permissions and the groups that hold them for entity type {entity_type}.
        slots:
          entity_type: query.entity-type
      - text: Show which groups have permissions in project {project}.
        slots:
          project: query.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my permissions in the v1 service
      effect: read
      questions:
      - What permissions does my account have in the v1 service?
      - How do I check what I am allowed to do before calling other v1 endpoints?
      instructions:
      - text: Get my v1 permissions.
      - text: Tell me what my account is permitted to do in the v1 service.
      method: generated
      generated: '2026-09-26'