Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GlobalProtect Source Applications API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-source-applications-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-profile-source-applications'].get
$.paths['/forwarding-profile-source-applications'].post
$.paths['/forwarding-profile-source-applications/{id}'].get
$.paths['/forwarding-profile-source-applications/{id}'].put
$.paths['/forwarding-profile-source-applications/{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 Source Applications API
  version: 1.0.0
extends: openapi/palo-alto-networks-source-applications-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-profile-source-applications'].get
  update:
    x-apievangelist-phrasing:
      intent: List GlobalProtect source applications
      effect: read
      questions:
      - Which GlobalProtect source applications are defined for forwarding profiles?
      - Can I search source applications by name?
      instructions:
      - text: List GlobalProtect source applications in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the source application named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/forwarding-profile-source-applications'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a GlobalProtect source application
      effect: write
      questions:
      - How do I group applications into a source application for a forwarding profile?
      - What do I need to define a new GlobalProtect source application?
      instructions:
      - text: Create source application {name} with applications {applications}.
        slots:
          name: requestBody.name
          applications: requestBody.applications
      - text: Add GlobalProtect source application {name} described as {description} containing {applications}.
        slots:
          name: requestBody.name
          description: requestBody.description
          applications: requestBody.applications
      method: generated
      generated: '2026-09-26'
- target: $.paths['/forwarding-profile-source-applications/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a GlobalProtect source application
      effect: read
      questions:
      - Which applications are in one GlobalProtect source application?
      - Can I read a source application by its ID?
      instructions:
      - text: Get GlobalProtect source application {id}.
        slots:
          id: path.id
      - text: Show the applications in source application {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/forwarding-profile-source-applications/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a GlobalProtect source application
      effect: write
      questions:
      - Can I add more apps to an existing GlobalProtect source application?
      - How do I rename a source application?
      instructions:
      - text: Update source application {id} ({name}) to contain {applications}.
        slots:
          id: path.id
          name: requestBody.name
          applications: requestBody.applications
      - text: Rename GlobalProtect source application {id} to {name}, keeping apps {applications}.
        slots:
          id: path.id
          name: requestBody.name
          applications: requestBody.applications
      method: generated
      generated: '2026-09-26'
- target: $.paths['/forwarding-profile-source-applications/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a GlobalProtect source application
      effect: destructive
      questions:
      - How do I delete a GlobalProtect source application?
      - Will forwarding profiles break if a source application is removed?
      instructions:
      - text: Delete GlobalProtect source application {id}.
        slots:
          id: path.id
      - text: Remove source application {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'