Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Device Onboarding Site Groups API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-site-groups-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['/site-groups'].get

$.paths['/site-groups'].post

$.paths['/site-groups/{id}'].get

$.paths['/site-groups/{id}'].put

$.paths['/site-groups/{id}'].delete

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 Device Onboarding Site Groups API
  version: 1.0.0
extends: openapi/palo-alto-networks-site-groups-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['/site-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List site groups
      effect: read
      questions:
      - What site groups exist in my tenant?
      - Can I see every site group at once?
      instructions:
      - text: List all site groups.
      - text: Show the site groups defined for this tenant.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/site-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a site group
      effect: write
      questions:
      - How do I create a site group with its own list of properties?
      - Can onboarding rule variables reference properties of a new site group?
      instructions:
      - text: Create site group {name}.
        slots:
          name: requestBody.name
      - text: Add site group {name} with properties {properties} and description {description}.
        slots:
          name: requestBody.name
          properties: requestBody.properties
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/site-groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a site group
      effect: read
      questions:
      - What properties does a particular site group define?
      - Can I retrieve a site group by its UUID?
      instructions:
      - text: Show site group {id}.
        slots:
          id: path.id
      - text: Get the property list of site group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/site-groups/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a site group
      effect: write
      questions:
      - Why would renaming a site group be blocked?
      - Can I change a site group's property list when sites are unclaimed?
      instructions:
      - text: Update site group {id} with name {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Change the description of existing site group {id} ({name}) to {description}.
        slots:
          id: path.id
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/site-groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a site group
      effect: destructive
      questions:
      - Can I delete a site group that sites or onboarding rules still use?
      - How do I remove an empty site group?
      instructions:
      - text: Delete site group {id}.
        slots:
          id: path.id
      - text: Remove the unused site group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'