Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Network Services BGP Route Maps API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-bgp-route-maps-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['/bgp-route-maps'].get
$.paths['/bgp-route-maps'].post
$.paths['/bgp-route-maps/{id}'].get
$.paths['/bgp-route-maps/{id}'].put
$.paths['/bgp-route-maps/{id}'].delete

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 Network Services BGP Route Maps API
  version: 1.0.0
extends: openapi/palo-alto-networks-bgp-route-maps-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['/bgp-route-maps'].get
  update:
    x-apievangelist-phrasing:
      intent: List BGP route maps
      effect: read
      questions:
      - Which BGP route maps are configured on my firewalls?
      - Can I list BGP route maps for one folder, snippet or device?
      instructions:
      - text: List all BGP route maps.
      - text: Show BGP route maps in folder {folder}.
        slots:
          folder: query.folder
      - text: List BGP route maps configured on device {device}.
        slots:
          device: query.device
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bgp-route-maps'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a BGP route map
      effect: write
      questions:
      - How do I create a BGP route map to control route redistribution?
      - Can I define the route map entries when creating it?
      instructions:
      - text: Create BGP route map {name}.
        slots:
          name: requestBody.name
      - text: Add BGP route map {name} with entries {route_map}.
        slots:
          name: requestBody.name
          route_map: requestBody.route_map
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bgp-route-maps/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a BGP route map
      effect: read
      questions:
      - What match and set rules are in a specific BGP route map?
      - Can I fetch a BGP route map by its ID?
      instructions:
      - text: Show BGP route map {id}.
        slots:
          id: path.id
      - text: Get the entries of BGP route map {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bgp-route-maps/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a BGP route map
      effect: write
      questions:
      - How do I change the entries of an existing BGP route map?
      - Can I rename a BGP route map?
      instructions:
      - text: Update BGP route map {id} named {name} with entries {route_map}.
        slots:
          id: path.id
          name: requestBody.name
          route_map: requestBody.route_map
      - text: Rename BGP route map {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bgp-route-maps/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a BGP route map
      effect: destructive
      questions:
      - How do I delete a BGP route map?
      - What happens to routing if I remove a BGP route map in use?
      instructions:
      - text: Delete BGP route map {id}.
        slots:
          id: path.id
      - text: Remove the unused BGP route map {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'