Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for LXD external REST Oidc Sessions API

5 actions 5 updates phrasing extends openapi/canonical-oidc-sessions-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['/1.0/auth/oidc-sessions'].get

$.paths['/1.0/auth/oidc-sessions/{id}'].get

$.paths['/1.0/auth/oidc-sessions/{id}'].delete

$.paths['/1.0/auth/oidc-sessions?recursion=1'].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 LXD external REST Oidc Sessions API
  version: 1.0.0
extends: openapi/canonical-oidc-sessions-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: 4
- target: $.paths['/1.0/auth/oidc-sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List OIDC session URLs
      effect: read
      questions:
      - Which OIDC login sessions are open on my LXD server, as links?
      - Can I list session URLs for one user's email?
      instructions:
      - text: List OIDC session URLs for {email}.
        slots:
          email: query.email
      - text: Give me links to every OIDC session.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1.0/auth/oidc-sessions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one OIDC session
      effect: read
      questions:
      - What are the details of a specific OIDC session?
      - Can I look up a single login session by its ID?
      instructions:
      - text: Show OIDC session {id}.
        slots:
          id: path.id
      - text: Look up one login session's details.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/auth/oidc-sessions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: End an OIDC session
      effect: destructive
      questions:
      - How do I force a user's OIDC session to end?
      - Can I delete a single login session on LXD?
      instructions:
      - text: Delete OIDC session {id}.
        slots:
          id: path.id
      - text: Revoke this login session now.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/auth/oidc-sessions?recursion=1'].get
  update:
    x-apievangelist-phrasing:
      intent: List OIDC sessions with full details
      effect: read
      questions:
      - Can I see full details of every OIDC session, like when each expires?
      - What sessions does a given email have open, in detail?
      instructions:
      - text: Fetch full OIDC session records for {email}.
        slots:
          email: query.email
      - text: Show all OIDC sessions with details, not just URLs.
      method: generated
      generated: '2026-09-26'