Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for LXD external REST Network Load Balancer Pools API

7 actions 7 updates phrasing extends openapi/canonical-network-load-balancer-pools-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 7

$.info
$.paths['/1.0/networks/{networkName}/load-balancer-pools'].get
$.paths['/1.0/networks/{networkName}/load-balancer-pools'].post
$.paths['/1.0/networks/{networkName}/load-balancer-pools/{poolName}'].get
$.paths['/1.0/networks/{networkName}/load-balancer-pools/{poolName}'].put
$.paths['/1.0/networks/{networkName}/load-balancer-pools/{poolName}'].delete
$.paths['/1.0/networks/{networkName}/load-balancer-pools/{poolName}/state'].get

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 LXD external REST Network Load Balancer Pools API
  version: 1.0.0
extends: openapi/canonical-network-load-balancer-pools-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: 6
- target: $.paths['/1.0/networks/{networkName}/load-balancer-pools'].get
  update:
    x-apievangelist-phrasing:
      intent: List a network's load balancer pools
      effect: read
      questions:
      - Which load balancer pools exist on one of my LXD networks?
      - Can I list pools for a network in a specific project?
      instructions:
      - text: List the load balancer pools on this network.
      - text: List network load balancer pools in project {project}.
        slots:
          project: query.project
      - text: Give me links to each backend pool defined on {network}.
        slots:
          network: path.networkName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/networks/{networkName}/load-balancer-pools'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a network load balancer pool
      effect: write
      questions:
      - How do I group instances into a load balancer pool?
      - Can a new pool be created with its member instances already set?
      instructions:
      - text: Create load balancer pool {name}.
        slots:
          name: requestBody.name
      - text: Add pool {name} containing instances {instances}.
        slots:
          name: requestBody.name
          instances: requestBody.instances
      - text: Create load balancer pool {name} on network {network}.
        slots:
          network: path.networkName
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/networks/{networkName}/load-balancer-pools/{poolName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a network load balancer pool
      effect: read
      questions:
      - Which instances belong to a particular load balancer pool?
      - What configuration does one pool carry?
      instructions:
      - text: Show this load balancer pool and its instances.
      - text: Get the pool details in project {project}.
        slots:
          project: query.project
      - text: Show load balancer pool {pool} on network {network}.
        slots:
          network: path.networkName
          pool: path.poolName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/networks/{networkName}/load-balancer-pools/{poolName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a network load balancer pool
      effect: write
      questions:
      - How do I change which instances are in a load balancer pool?
      - Can I update a pool's config and description together?
      instructions:
      - text: Set the pool's instances to {instances}.
        slots:
          instances: requestBody.instances
      - text: Update the pool config to {config} with description {description}.
        slots:
          config: requestBody.config
          description: requestBody.description
      - text: Set the instances of pool {pool} on network {network} to {instances}.
        slots:
          network: path.networkName
          pool: path.poolName
          instances: requestBody.instances
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/networks/{networkName}/load-balancer-pools/{poolName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a network load balancer pool
      effect: destructive
      questions:
      - How do I remove a load balancer pool from a network?
      - Can I delete a pool that lives in another project?
      instructions:
      - text: Delete this load balancer pool.
      - text: Remove the pool from project {project}.
        slots:
          project: query.project
      - text: Delete load balancer pool {pool} from network {network}.
        slots:
          network: path.networkName
          pool: path.poolName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/networks/{networkName}/load-balancer-pools/{poolName}/state'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the state of a load balancer pool
      effect: read
      questions:
      - Are the members of my load balancer pool healthy right now?
      - What runtime state does a pool report?
      instructions:
      - text: Show the current state of this load balancer pool.
      - text: Check pool health state in project {project}.
        slots:
          project: query.project
      - text: Show the health state of pool {pool} on network {network}.
        slots:
          network: path.networkName
          pool: path.poolName
      method: generated
      generated: '2026-10-01'