Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Network Services BGP Redistribution Profiles API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-bgp-redistribution-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-redistribution-profiles'].get

$.paths['/bgp-redistribution-profiles'].post

$.paths['/bgp-redistribution-profiles/{id}'].get

$.paths['/bgp-redistribution-profiles/{id}'].put

$.paths['/bgp-redistribution-profiles/{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 BGP Redistribution Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-bgp-redistribution-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-redistribution-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List BGP redistribution profiles
      effect: read
      questions:
      - Which BGP redistribution profiles are defined?
      - Can I filter BGP redistribution profiles by folder or device?
      instructions:
      - text: List all BGP redistribution profiles.
      - text: List BGP redistribution profiles in folder {folder}.
        slots:
          folder: query.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bgp-redistribution-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a BGP redistribution profile
      effect: write
      questions:
      - How do I redistribute static or connected routes into BGP?
      - What IPv4 settings does a new BGP redistribution profile need?
      instructions:
      - text: Create BGP redistribution profile {name} with IPv4 settings {ipv4}.
        slots:
          name: requestBody.name
          ipv4: requestBody.ipv4
      - text: Add a new BGP redistribution profile named {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bgp-redistribution-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a BGP redistribution profile
      effect: read
      questions:
      - What routes does a particular BGP redistribution profile redistribute?
      - Can I fetch one BGP redistribution profile by ID?
      instructions:
      - text: Get BGP redistribution profile {id}.
        slots:
          id: path.id
      - text: Show the IPv4 settings of BGP redistribution profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bgp-redistribution-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a BGP redistribution profile
      effect: write
      questions:
      - How do I change which routes an existing BGP redistribution profile covers?
      - Can I rename a BGP redistribution profile?
      instructions:
      - text: Update BGP redistribution profile {id} with IPv4 settings {ipv4}.
        slots:
          id: path.id
          ipv4: requestBody.ipv4
      - text: Rename BGP redistribution profile {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bgp-redistribution-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a BGP redistribution profile
      effect: destructive
      questions:
      - How do I remove a BGP redistribution profile?
      - Is deleting a BGP redistribution profile by ID permanent?
      instructions:
      - text: Delete BGP redistribution profile {id}.
        slots:
          id: path.id
      - text: Remove the BGP redistribution profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'