Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GlobalProtect Forwarding Profiles API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-forwarding-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['/forwarding-profiles'].get
$.paths['/forwarding-profiles'].post
$.paths['/forwarding-profiles/{id}'].get
$.paths['/forwarding-profiles/{id}'].put
$.paths['/forwarding-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 GlobalProtect Forwarding Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-forwarding-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['/forwarding-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List GlobalProtect forwarding profiles
      effect: read
      questions:
      - Which GlobalProtect forwarding profiles are configured in a folder?
      - Can I find a forwarding profile by its name?
      instructions:
      - text: List GlobalProtect forwarding profiles in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the GlobalProtect forwarding profile named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/forwarding-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a GlobalProtect forwarding profile
      effect: write
      questions:
      - How do I set up a new GlobalProtect forwarding profile?
      - Can I choose the profile type and definition method when creating a forwarding profile?
      instructions:
      - text: Create GlobalProtect forwarding profile {name} of type {type} in folder {folder}.
        slots:
          name: requestBody.name
          type: requestBody.type
          folder: query.folder
      - text: Add a forwarding profile {name} using definition method {definition_method}.
        slots:
          name: requestBody.name
          definition_method: requestBody.definition_method
      method: generated
      generated: '2026-09-26'
- target: $.paths['/forwarding-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a GlobalProtect forwarding profile
      effect: read
      questions:
      - What type and definition method does a given forwarding profile use?
      - How do I retrieve one GlobalProtect forwarding profile by ID?
      instructions:
      - text: Get GlobalProtect forwarding profile {id}.
        slots:
          id: path.id
      - text: Show the configuration of forwarding profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/forwarding-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a GlobalProtect forwarding profile
      effect: write
      questions:
      - Can I change the type of an existing GlobalProtect forwarding profile?
      - How do I edit a forwarding profile's description?
      instructions:
      - text: Change forwarding profile {id} ({name}) to type {type}.
        slots:
          id: path.id
          name: requestBody.name
          type: requestBody.type
      - text: Update the description of GlobalProtect forwarding profile {id} named {name} to {description}.
        slots:
          id: path.id
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/forwarding-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a GlobalProtect forwarding profile
      effect: destructive
      questions:
      - How do I remove a GlobalProtect forwarding profile?
      - Is a deleted forwarding profile recoverable?
      instructions:
      - text: Delete GlobalProtect forwarding profile {id}.
        slots:
          id: path.id
      - text: Remove the forwarding profile with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'