Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Network Services BGP Filtering Profiles API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-bgp-filtering-profiles-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-filtering-profiles'].get
$.paths['/bgp-filtering-profiles'].post
$.paths['/bgp-filtering-profiles/{id}'].get
$.paths['/bgp-filtering-profiles/{id}'].put
$.paths['/bgp-filtering-profiles/{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 Filtering Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-bgp-filtering-profiles-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-filtering-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List BGP filtering profiles
      effect: read
      questions:
      - Which BGP filtering profiles are configured in a folder?
      - Can I look up a BGP filtering profile by name on a device?
      instructions:
      - text: List BGP filtering profiles in folder {folder}.
        slots:
          folder: query.folder
      - text: Find BGP filtering profile {name} on device {device}.
        slots:
          name: query.name
          device: query.device
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bgp-filtering-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a BGP filtering profile
      effect: write
      questions:
      - How do I create a BGP filtering profile for IPv4 routes?
      - What does a new BGP filtering profile need besides a name?
      instructions:
      - text: Create BGP filtering profile {name}.
        slots:
          name: requestBody.name
      - text: Create BGP filtering profile {name} with IPv4 filters {ipv4}.
        slots:
          name: requestBody.name
          ipv4: requestBody.ipv4
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bgp-filtering-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a BGP filtering profile
      effect: read
      questions:
      - What IPv4 filters are in a specific BGP filtering profile?
      - Can I fetch a BGP filtering profile by ID?
      instructions:
      - text: Get BGP filtering profile {id}.
        slots:
          id: path.id
      - text: Show the IPv4 filter settings of BGP profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bgp-filtering-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a BGP filtering profile
      effect: write
      questions:
      - Can I change the IPv4 filters on an existing BGP filtering profile?
      - What's the call to rename a BGP filtering profile?
      instructions:
      - text: Update BGP filtering profile {id} ({name}) with IPv4 filters {ipv4}.
        slots:
          id: path.id
          name: requestBody.name
          ipv4: requestBody.ipv4
      - text: Rename BGP filtering profile {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bgp-filtering-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a BGP filtering profile
      effect: destructive
      questions:
      - How do I delete a BGP filtering profile I don't need?
      - Can I remove a BGP filtering profile by its ID?
      instructions:
      - text: Delete BGP filtering profile {id}.
        slots:
          id: path.id
      - text: Remove BGP profile {id} from the configuration.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'