Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Configuration Setup Variables API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-variables-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['/variables'].get
$.paths['/variables'].post
$.paths['/variables/{id}'].get
$.paths['/variables/{id}'].put
$.paths['/variables/{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 Configuration Setup Variables API
  version: 1.0.0
extends: openapi/palo-alto-networks-variables-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['/variables'].get
  update:
    x-apievangelist-phrasing:
      intent: List configuration variables
      effect: read
      questions:
      - Which configuration variables are defined in my tenant?
      - Can I list the variables for one folder, snippet or device?
      instructions:
      - text: List all variables.
      - text: List variables in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the variable named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/variables'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a configuration variable
      effect: write
      questions:
      - How do I define a variable that devices can reuse in their configuration?
      - Can I create a variable scoped to one folder or device?
      instructions:
      - text: Create variable {name} of type {type} with value {value}.
        slots:
          name: requestBody.name
          type: requestBody.type
          value: requestBody.value
      - text: Create variable {name} in folder {folder} set to {value}.
        slots:
          name: requestBody.name
          folder: query.folder
          value: requestBody.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/variables/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a configuration variable
      effect: read
      questions:
      - What value and type does a specific variable hold?
      - Can I look up one variable by id?
      instructions:
      - text: Get variable {id}.
        slots:
          id: path.id
      - text: Show the value of variable {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/variables/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a configuration variable
      effect: write
      questions:
      - How do I change the value of an existing variable?
      - Can I mark an existing variable as overridden?
      instructions:
      - text: Set variable {id} value to {value}.
        slots:
          id: path.id
          value: requestBody.value
      - text: Update variable {id} named {name} with type {type} and value {value}.
        slots:
          id: path.id
          name: requestBody.name
          type: requestBody.type
          value: requestBody.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/variables/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a configuration variable
      effect: destructive
      questions:
      - Which call removes a variable I no longer use?
      - Is deleting a variable permanent?
      instructions:
      - text: Delete variable {id}.
        slots:
          id: path.id
      - text: Remove the variable with id {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'