# 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 Server API
  version: 1.0.0
extends: openapi/canonical-server-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: 7
- target: $.paths['/'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported API versions
      effect: read
      questions:
      - Which API versions does this LXD server support?
      - How do I discover the versioned endpoints an LXD server exposes?
      instructions:
      - text: List the API versions the server supports.
      - text: Show me the root API endpoints available.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1.0'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the server environment and config
      effect: read
      questions:
      - How do I see the full LXD server configuration and environment?
      - What version and storage drivers is my server running?
      instructions:
      - text: Show the full server environment and configuration.
      - text: Get the server config as seen by cluster member {target}.
        slots:
          target: query.target
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1.0'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace the server configuration
      effect: write
      questions:
      - Can I replace the entire LXD server configuration at once?
      - What happens to server keys I leave out of a full config update?
      instructions:
      - text: Replace the server configuration with {config}.
        slots:
          config: requestBody.config
      - text: Overwrite the config on member {target} with {config}.
        slots:
          target: query.target
          config: requestBody.config
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1.0'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change some server settings
      effect: write
      questions:
      - How do I set one server option like core.https_address?
      - Can I change a single server setting without resending the rest?
      instructions:
      - text: Merge {config} into the server's existing settings.
        slots:
          config: requestBody.config
      - text: Patch server settings on member {target} with {config}.
        slots:
          target: query.target
          config: requestBody.config
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1.0/events'].get
  update:
    x-apievangelist-phrasing:
      intent: Stream server events
      effect: read
      questions:
      - How do I subscribe to live LXD events over a websocket?
      - Can I only receive lifecycle or logging events?
      instructions:
      - text: Stream events of type {type}.
        slots:
          type: query.type
      - text: Connect to the event stream for project {project}.
        slots:
          project: query.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1.0/resources'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the server's hardware inventory
      effect: read
      questions:
      - What CPUs, memory and GPUs does my LXD host have?
      - How do I see the hardware profile of one cluster member?
      instructions:
      - text: Show the hardware resources of the server.
      - text: Get the hardware profile of member {target}.
        slots:
          target: query.target
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1.0?public'].get
  update:
    x-apievangelist-phrasing:
      intent: Get public server info for untrusted clients
      effect: read
      questions:
      - What server details can an unauthenticated client see?
      - How does a new client check a server's auth methods before trusting it?
      instructions:
      - text: Show the public subset of the server environment.
      - text: Get the server info available without a trusted certificate.
      method: generated
      generated: '2026-09-26'