Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Configuration Setup Folders API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-folders-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['/folders'].get
$.paths['/folders'].post
$.paths['/folders/{id}'].get
$.paths['/folders/{id}'].put
$.paths['/folders/{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 Folders API
  version: 1.0.0
extends: openapi/palo-alto-networks-folders-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['/folders'].get
  update:
    x-apievangelist-phrasing:
      intent: List configuration folders
      effect: read
      questions:
      - Which configuration folders exist in Strata Cloud Manager?
      - Can I look up a folder by name?
      instructions:
      - text: List all configuration folders.
      - text: Find the folder named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/folders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a configuration folder
      effect: write
      questions:
      - How do I create a new folder under an existing parent folder?
      - Can I attach labels and snippets to a folder when I create it?
      instructions:
      - text: Create folder {name} with ID {id} under parent {parent}.
        slots:
          name: requestBody.name
          id: requestBody.id
          parent: requestBody.parent
      - text: Add folder {name} (ID {id}) beneath {parent} with snippets {snippets}.
        slots:
          name: requestBody.name
          id: requestBody.id
          parent: requestBody.parent
          snippets: requestBody.snippets
      method: generated
      generated: '2026-09-26'
- target: $.paths['/folders/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a configuration folder
      effect: read
      questions:
      - What's the parent and snippet list of a specific folder?
      - Can I retrieve one folder by its UUID?
      instructions:
      - text: Get folder {id}.
        slots:
          id: path.id
      - text: Show the labels and snippets on folder {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/folders/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a configuration folder
      effect: write
      questions:
      - How do I move an existing folder to a different parent?
      - Can I change the labels on a folder after it's created?
      instructions:
      - text: 'Update existing folder {id}: name {name}, parent {parent}.'
        slots:
          id: path.id
          name: requestBody.name
          parent: requestBody.parent
      - text: Set the labels on existing folder {id} to {labels}.
        slots:
          id: path.id
          labels: requestBody.labels
      method: generated
      generated: '2026-09-26'
- target: $.paths['/folders/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a configuration folder
      effect: destructive
      questions:
      - How do I remove a folder I no longer use?
      - Can a folder be deleted by its UUID?
      instructions:
      - text: Delete folder {id}.
        slots:
          id: path.id
      - text: Remove the configuration folder with UUID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'