Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GlobalProtect User Locations API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-user-locations-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-user-locations'].get
$.paths['/forwarding-profile-user-locations'].post
$.paths['/forwarding-profile-user-locations/{id}'].get
$.paths['/forwarding-profile-user-locations/{id}'].put
$.paths['/forwarding-profile-user-locations/{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 User Locations API
  version: 1.0.0
extends: openapi/palo-alto-networks-user-locations-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-user-locations'].get
  update:
    x-apievangelist-phrasing:
      intent: List GlobalProtect user locations
      effect: read
      questions:
      - Which GlobalProtect user locations are set up for forwarding profiles?
      - Can I find a GlobalProtect user location by name in a folder?
      instructions:
      - text: List GlobalProtect user locations.
      - text: Find GlobalProtect user location {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/forwarding-profile-user-locations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a GlobalProtect user location
      effect: write
      questions:
      - How do I add a new GlobalProtect user location for a forwarding profile?
      - What location choice do I need to give when creating a user location?
      instructions:
      - text: Create GlobalProtect user location {name} with location choice {choice}.
        slots:
          name: requestBody.name
          choice: requestBody.choice
      - text: Add user location {name} described as {description} using {choice} in folder {folder}.
        slots:
          name: requestBody.name
          description: requestBody.description
          choice: requestBody.choice
          folder: query.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/forwarding-profile-user-locations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a GlobalProtect user location
      effect: read
      questions:
      - How do I view the details of one GlobalProtect user location?
      - Can I fetch a user location by its ID?
      instructions:
      - text: Get GlobalProtect user location {id}.
        slots:
          id: path.id
      - text: Show the settings of user location {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/forwarding-profile-user-locations/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a GlobalProtect user location
      effect: write
      questions:
      - How do I change the location choice on an existing GlobalProtect user location?
      - Can I update a user location's description?
      instructions:
      - text: Update user location {id} named {name} to choice {choice}.
        slots:
          id: path.id
          name: requestBody.name
          choice: requestBody.choice
      - text: Set the description of user location {id} ({name}, {choice}) to {description}.
        slots:
          id: path.id
          name: requestBody.name
          choice: requestBody.choice
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/forwarding-profile-user-locations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a GlobalProtect user location
      effect: destructive
      questions:
      - How do I delete a GlobalProtect user location?
      - Can I remove a user location by ID?
      instructions:
      - text: Delete GlobalProtect user location {id}.
        slots:
          id: path.id
      - text: Remove user location {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'