Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Configuration Setup Snippets API

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

$.info
$.paths['/snippets'].get
$.paths['/snippets'].post
$.paths['/snippets/{id}'].get
$.paths['/snippets/{id}'].put
$.paths['/snippets/{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 Snippets API
  version: 1.0.0
extends: openapi/palo-alto-networks-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: 5
- target: $.paths['/snippets'].get
  update:
    x-apievangelist-phrasing:
      intent: List configuration snippets
      effect: read
      questions:
      - What configuration snippets exist in my Strata Cloud Manager tenant?
      - Can I search snippets by name and page through the results?
      instructions:
      - text: List all my configuration snippets.
      - text: Find the snippet named {name}.
        slots:
          name: query.name
      - text: Show {limit} snippets starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/snippets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a configuration snippet
      effect: write
      questions:
      - How do I create a reusable configuration snippet in Strata Cloud Manager?
      - Can I add labels and a description when creating a snippet?
      instructions:
      - text: Create a snippet named {name} with UUID {id}.
        slots:
          name: requestBody.name
          id: requestBody.id
      - text: Create snippet {name} (UUID {id}) labelled {labels} and described as {description}.
        slots:
          name: requestBody.name
          id: requestBody.id
          labels: requestBody.labels
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/snippets/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a configuration snippet
      effect: read
      questions:
      - How do I look up a single snippet by its UUID?
      - What type and labels does a particular snippet have?
      instructions:
      - text: Show snippet {id}.
        slots:
          id: path.id
      - text: Retrieve the details of the snippet with UUID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/snippets/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a configuration snippet
      effect: write
      questions:
      - Can I rename an existing snippet or change its labels?
      - How do I edit the description of a snippet I already have?
      instructions:
      - text: Rename existing snippet {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update the labels on snippet {id} ({name}) to {labels}.
        slots:
          id: path.id
          name: requestBody.name
          labels: requestBody.labels
      method: generated
      generated: '2026-09-26'
- target: $.paths['/snippets/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a configuration snippet
      effect: destructive
      questions:
      - How do I remove a snippet I no longer use?
      - Can a configuration snippet be deleted by UUID?
      instructions:
      - text: Delete snippet {id}.
        slots:
          id: path.id
      - text: Remove the configuration snippet with UUID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'