Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Network Services BGP Authentication Profiles API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-bgp-authentication-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-auth-profiles'].get
$.paths['/bgp-auth-profiles'].post
$.paths['/bgp-auth-profiles/{id}'].get
$.paths['/bgp-auth-profiles/{id}'].put
$.paths['/bgp-auth-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 Authentication Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-bgp-authentication-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-auth-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List BGP authentication profiles
      effect: read
      questions:
      - Which BGP authentication profiles are configured in a folder or on a device?
      - Can I look up a BGP auth profile by name?
      instructions:
      - text: List BGP authentication profiles in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the BGP authentication profile named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bgp-auth-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a BGP authentication profile
      effect: write
      questions:
      - How do I set up a shared secret for BGP peer authentication?
      - What is needed to create a new BGP authentication profile?
      instructions:
      - text: Create BGP authentication profile {name}.
        slots:
          name: requestBody.name
      - text: Create BGP auth profile {name} with secret {secret}.
        slots:
          name: requestBody.name
          secret: requestBody.secret
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bgp-auth-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a BGP authentication profile
      effect: read
      questions:
      - Where can I view one BGP authentication profile by ID?
      - What does a stored BGP auth profile contain?
      instructions:
      - text: Get BGP authentication profile {id}.
        slots:
          id: path.id
      - text: Show BGP auth profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bgp-auth-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a BGP authentication profile
      effect: write
      questions:
      - How do I rotate the secret on an existing BGP authentication profile?
      - Can I rename a BGP auth profile?
      instructions:
      - text: Update BGP auth profile {id} with new secret {secret}, keeping name {name}.
        slots:
          id: path.id
          secret: requestBody.secret
          name: requestBody.name
      - text: Rename BGP authentication profile {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bgp-auth-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a BGP authentication profile
      effect: destructive
      questions:
      - Can I delete a BGP authentication profile I no longer use?
      - Is a BGP auth profile removed by its ID?
      instructions:
      - text: Delete BGP authentication profile {id}.
        slots:
          id: path.id
      - text: Remove BGP auth profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'