Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Configuration Setup Shared Snippets API

4 actions 4 updates phrasing extends openapi/palo-alto-networks-shared-snippets-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 4

$.info

$.paths['/shared-snippets'].get

$.paths['/shared-snippets'].put

$.paths['/shared-snippets:load'].post

OpenAPI Overlay

# 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 Shared Snippets API
  version: 1.0.0
extends: openapi/palo-alto-networks-shared-snippets-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: 3
- target: $.paths['/shared-snippets'].get
  update:
    x-apievangelist-phrasing:
      intent: List shared snippets
      effect: read
      questions:
      - Which shared configuration snippets are available to me?
      - What snippets have been shared with my tenant?
      instructions:
      - text: List shared snippets.
      - text: Show all snippets shared with me.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shared-snippets'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a shared snippet
      effect: write
      questions:
      - How do I pull the latest version of a shared snippet?
      - Can I pause updates to a shared snippet or validate before updating?
      instructions:
      - text: Update shared snippet {id}.
        slots:
          id: requestBody.id
      - text: 'Pause updates on shared snippet {id}: {pause_update}.'
        slots:
          id: requestBody.id
          pause_update: requestBody.pause_update
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shared-snippets:load'].post
  update:
    x-apievangelist-phrasing:
      intent: Load a shared snippet into configuration
      effect: write
      questions:
      - How do I load a shared snippet so it can be used in my config?
      - Can I validate a shared snippet while loading it?
      instructions:
      - text: Load shared snippet {id}.
        slots:
          id: requestBody.id
      - text: Load and convert shared snippet {id} with validation {validation}.
        slots:
          id: requestBody.id
          validation: requestBody.validation
      method: generated
      generated: '2026-09-26'