Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Network Services Logical Routers API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-logical-routers-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Palo Alto Networks's API. It is a proposal applied on top of the contract, not a document Palo Alto Networks publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/logical-routers'].get

$.paths['/logical-routers'].post

$.paths['/logical-routers/{id}'].get

$.paths['/logical-routers/{id}'].put

$.paths['/logical-routers/{id}'].delete

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 Network Services Logical Routers API
  version: 1.0.0
extends: openapi/palo-alto-networks-logical-routers-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: 5
- target: $.paths['/logical-routers'].get
  update:
    x-apievangelist-phrasing:
      intent: List logical routers
      effect: read
      questions:
      - Which logical routers are defined in a folder?
      - Can I get a paginated list of logical routers on one device?
      instructions:
      - text: List logical routers in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the logical router named {name} on device {device}.
        slots:
          name: query.name
          device: query.device
      method: generated
      generated: '2026-09-26'
- target: $.paths['/logical-routers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a logical router
      effect: write
      questions:
      - How do I add a new logical router with its own VRFs?
      - Can I pick the routing stack when creating a logical router?
      instructions:
      - text: Create logical router {name}.
        slots:
          name: requestBody.name
      - text: Create logical router {name} with routing stack {routing_stack} and VRFs {vrf}.
        slots:
          name: requestBody.name
          routing_stack: requestBody.routing_stack
          vrf: requestBody.vrf
      method: generated
      generated: '2026-09-26'
- target: $.paths['/logical-routers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a logical router
      effect: read
      questions:
      - What VRFs does a particular logical router have?
      - Can I view one logical router by UUID?
      instructions:
      - text: Get logical router {id}.
        slots:
          id: path.id
      - text: Show the VRF configuration of logical router {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/logical-routers/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a logical router
      effect: write
      questions:
      - How do I change the VRFs on an existing logical router?
      - Can I switch the routing stack of a logical router I already have?
      instructions:
      - text: Update logical router {id} with VRFs {vrf}.
        slots:
          id: path.id
          vrf: requestBody.vrf
      - text: Rename existing logical router {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/logical-routers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a logical router
      effect: destructive
      questions:
      - Is there a way to remove a logical router?
      - Can I delete a logical router by its UUID?
      instructions:
      - text: Delete logical router {id}.
        slots:
          id: path.id
      - text: Remove the logical router {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'