# 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 Networks API
  version: 1.0.0
extends: openapi/canonical-networks-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: 10
- target: $.paths['/1.0/networks'].get
  update:
    x-apievangelist-phrasing:
      intent: List network URLs
      effect: read
      questions:
      - Which networks are defined on my LXD server?
      - Can I get network links across all projects?
      instructions:
      - text: List the network URLs in project {project}.
        slots:
          project: query.project
      - text: Give me links to all LXD networks.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1.0/networks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a network
      effect: write
      questions:
      - How do I create a new bridge network in LXD?
      - When clustered, do I need to create the network on each member first?
      instructions:
      - text: Create a {type} network named {name}.
        slots:
          type: requestBody.type
          name: requestBody.name
      - text: Define network {name} on cluster member {target} with config {config}.
        slots:
          name: requestBody.name
          target: query.target
          config: requestBody.config
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1.0/networks/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one network's configuration
      effect: read
      questions:
      - How do I see the configuration of a specific network?
      - Can I view a network's settings as seen on one cluster member?
      instructions:
      - text: Show the network's configuration in project {project}.
        slots:
          project: query.project
      - text: Get the network as defined on member {target}.
        slots:
          target: query.target
      - text: Show the configuration of network {network}.
        slots:
          network: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/networks/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a network's configuration
      effect: write
      questions:
      - Can I replace every setting of a network in one go?
      - How do I overwrite a network's whole config and description?
      instructions:
      - text: Replace the network configuration with {config}.
        slots:
          config: requestBody.config
      - text: Overwrite the network description with {description} and config {config}.
        slots:
          description: requestBody.description
          config: requestBody.config
      - text: Replace the entire configuration of network {network} with {config}.
        slots:
          network: path.name
          config: requestBody.config
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/networks/{name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename a network
      effect: write
      questions:
      - How do I rename an existing network?
      - Can a network be given a new name without recreating it?
      instructions:
      - text: Rename the network to {name}.
        slots:
          name: requestBody.name
      - text: Give the network in project {project} the new name {name}.
        slots:
          project: query.project
          name: requestBody.name
      - text: Rename network {network} to {name}.
        slots:
          network: path.name
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/networks/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a network
      effect: destructive
      questions:
      - How do I remove a network I no longer use?
      - Can I delete a network from a specific project?
      instructions:
      - text: Delete the network.
      - text: Remove the network from project {project}.
        slots:
          project: query.project
      - text: Delete network {network}.
        slots:
          network: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/networks/{name}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change some settings of a network
      effect: write
      questions:
      - Can I change one key like ipv4.address without resending the full config?
      - How do I tweak a network's settings on a single cluster member?
      instructions:
      - text: Merge {config} into the network's existing config.
        slots:
          config: requestBody.config
      - text: Patch the network on member {target} with {config}.
        slots:
          target: query.target
          config: requestBody.config
      - text: Merge config keys {config} into network {network}.
        slots:
          network: path.name
          config: requestBody.config
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/networks/{name}/leases'].get
  update:
    x-apievangelist-phrasing:
      intent: List a network's DHCP leases
      effect: read
      questions:
      - Which IP addresses has a network's DHCP server handed out?
      - How do I find what address an instance got from DHCP?
      instructions:
      - text: List the DHCP leases on the network.
      - text: Show DHCP leases on member {target}.
        slots:
          target: query.target
      - text: Report the IP addresses DHCP has handed out on {network}.
        slots:
          network: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/networks/{name}/state'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a network's live state
      effect: read
      questions:
      - Is my network interface up, and what are its counters?
      - How do I see the current addresses and traffic on a network?
      instructions:
      - text: Show the current state of the network.
      - text: Get the network's live state on member {target}.
        slots:
          target: query.target
      - text: Show the live state of network {network}.
        slots:
          network: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/networks?recursion=1'].get
  update:
    x-apievangelist-phrasing:
      intent: List networks with full details
      effect: read
      questions:
      - Can I list every network with its config, not just its URL?
      - How do I get full network records across all projects?
      instructions:
      - text: List all networks as full records in project {project}.
        slots:
          project: query.project
      - text: Give me detailed network entries across every project.
      method: generated
      generated: '2026-09-26'