# 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 Balancers API
  version: 1.0.0
extends: openapi/canonical-network-load-balancers-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: 7
- target: $.paths['/1.0/networks/{networkName}/load-balancers'].get
  update:
    x-apievangelist-phrasing:
      intent: List a network's load balancers as URLs
      effect: read
      questions:
      - Which load balancers are defined on one of my LXD networks?
      - Can I list load balancer URLs for a network in a given project?
      instructions:
      - text: List the load balancer URLs on this network.
      - text: List network load balancer URLs in project {project}.
        slots:
          project: query.project
      - text: Give me links to each load balancer defined on {network}.
        slots:
          network: path.networkName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/networks/{networkName}/load-balancers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a network load balancer
      effect: write
      questions:
      - How do I create a load balancer on an LXD network listening on an address?
      - Can I define backends and ports when adding a network load balancer?
      instructions:
      - text: Create a load balancer listening on {listen_address}.
        slots:
          listen_address: requestBody.listen_address
      - text: Add a load balancer on {listen_address} with backends {backends} and ports {ports}.
        slots:
          listen_address: requestBody.listen_address
          backends: requestBody.backends
          ports: requestBody.ports
      - text: Set up a new load balancer on {network} at address {listen_address}.
        slots:
          network: path.networkName
          listen_address: requestBody.listen_address
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/networks/{networkName}/load-balancers/{listenAddress}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a network load balancer
      effect: read
      questions:
      - What backends and ports does a specific load balancer use?
      - Where do I read the load balancer config for one listen address?
      instructions:
      - text: Show the load balancer for this listen address.
      - text: Get the network load balancer details in project {project}.
        slots:
          project: query.project
      - text: Show the load balancer at {listen_address} on network {network}.
        slots:
          network: path.networkName
          listen_address: path.listenAddress
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/networks/{networkName}/load-balancers/{listenAddress}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a network load balancer's configuration
      effect: write
      questions:
      - How do I overwrite all backends and ports on a load balancer?
      - Will replacing a load balancer drop backends I leave out?
      instructions:
      - text: Replace the load balancer's backends with {backends} and ports with {ports}.
        slots:
          backends: requestBody.backends
          ports: requestBody.ports
      - text: Overwrite the whole load balancer config with {config}.
        slots:
          config: requestBody.config
      - text: Replace the backends of load balancer {listen_address} on network {network} with {backends}.
        slots:
          network: path.networkName
          listen_address: path.listenAddress
          backends: requestBody.backends
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/networks/{networkName}/load-balancers/{listenAddress}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a network load balancer
      effect: destructive
      questions:
      - Is there a way to remove a load balancer from an LXD network?
      - Can I delete a load balancer that belongs to another project?
      instructions:
      - text: Delete the load balancer on this listen address.
      - text: Remove the network load balancer from project {project}.
        slots:
          project: query.project
      - text: Delete the load balancer at {listen_address} on network {network}.
        slots:
          network: path.networkName
          listen_address: path.listenAddress
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/networks/{networkName}/load-balancers/{listenAddress}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a network load balancer
      effect: write
      questions:
      - Can I change only the description of a network load balancer?
      - How do I update a load balancer's ports without resending its backends?
      instructions:
      - text: Patch the load balancer description to {description}.
        slots:
          description: requestBody.description
      - text: Update only the load balancer ports to {ports}.
        slots:
          ports: requestBody.ports
      - text: Patch load balancer {listen_address} on network {network}, changing only its description to {description}.
        slots:
          network: path.networkName
          listen_address: path.listenAddress
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/networks/{networkName}/load-balancers?recursion=1'].get
  update:
    x-apievangelist-phrasing:
      intent: List a network's load balancers with details
      effect: read
      questions:
      - How do I get every load balancer on a network with backends and ports in one call?
      - Can I list full load balancer objects instead of URLs?
      instructions:
      - text: List all load balancers on this network as full objects.
      - text: Get expanded load balancers for project {project}.
        slots:
          project: query.project
      - text: List every load balancer on network {network} with full details.
        slots:
          network: path.networkName
      method: generated
      generated: '2026-10-01'