Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Network Services BGP Address Family Profiles API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-bgp-address-family-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-address-family-profiles'].get
$.paths['/bgp-address-family-profiles'].post
$.paths['/bgp-address-family-profiles/{id}'].get
$.paths['/bgp-address-family-profiles/{id}'].put
$.paths['/bgp-address-family-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 Address Family Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-bgp-address-family-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-address-family-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List BGP address family profiles
      effect: read
      questions:
      - Which BGP address family profiles are defined in a folder?
      - Can I search BGP address family profiles by name?
      instructions:
      - text: List BGP address family profiles in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the BGP address family profile named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bgp-address-family-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a BGP address family profile
      effect: write
      questions:
      - How do I set up a new BGP address family profile with IPv4 settings?
      - What's required to create a BGP address family profile?
      instructions:
      - text: Create BGP address family profile {name} with IPv4 settings {ipv4}.
        slots:
          name: requestBody.name
          ipv4: requestBody.ipv4
      - text: Add a new BGP address family profile called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bgp-address-family-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a BGP address family profile
      effect: read
      questions:
      - What IPv4 settings does a particular BGP address family profile have?
      - How can I fetch one BGP address family profile by ID?
      instructions:
      - text: Get BGP address family profile {id}.
        slots:
          id: path.id
      - text: Show the IPv4 configuration of BGP address family profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bgp-address-family-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a BGP address family profile
      effect: write
      questions:
      - Can I change the IPv4 settings on an existing BGP address family profile?
      - How do I rename a BGP address family profile?
      instructions:
      - text: Update BGP address family profile {id} named {name} with IPv4 settings {ipv4}.
        slots:
          id: path.id
          name: requestBody.name
          ipv4: requestBody.ipv4
      - text: Rename BGP address family profile {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bgp-address-family-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a BGP address family profile
      effect: destructive
      questions:
      - How do I remove a BGP address family profile I no longer use?
      - Is deleting a BGP address family profile permanent?
      instructions:
      - text: Delete BGP address family profile {id}.
        slots:
          id: path.id
      - text: Remove the BGP address family profile with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'