Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Sites API

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

$.info

$.paths['/sdwan/config/v1/sites'].get

$.paths['/sdwan/config/v1/sites'].post

$.paths['/sdwan/config/v1/sites/{site_id}'].get

$.paths['/sdwan/config/v1/sites/{site_id}'].put

$.paths['/sdwan/config/v1/sites/{site_id}'].delete

$.paths['/sites'].get

$.paths['/sites'].post

$.paths['/sites/{id}'].get

$.paths['/sites/{id}'].put

$.paths['/sites/{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 Palo Alto Networks Sites API
  version: 1.0.0
extends: openapi/palo-alto-networks-sites-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: 10
- target: $.paths['/sdwan/config/v1/sites'].get
  update:
    x-apievangelist-phrasing:
      intent: List SD-WAN sites
      effect: read
      questions:
      - Which SD-WAN branch and data center sites are configured in my tenant?
      - Can I look up an SD-WAN site by name in the Prisma SD-WAN config?
      instructions:
      - text: List all SD-WAN sites in my tenant.
      - text: Find the SD-WAN site named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sdwan/config/v1/sites'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an SD-WAN site
      effect: write
      questions:
      - How do I add a new branch office as an SD-WAN site?
      - Can I set an address and admin state when creating an SD-WAN site?
      instructions:
      - text: Create an SD-WAN site named {name} at {address}.
        slots:
          name: requestBody.name
          address: requestBody.address
      - text: Add SD-WAN site {name} with cluster role {element_cluster_role}.
        slots:
          name: requestBody.name
          element_cluster_role: requestBody.element_cluster_role
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sdwan/config/v1/sites/{site_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an SD-WAN site's configuration
      effect: read
      questions:
      - What is the configuration of a specific SD-WAN site?
      - Can I see the admin state and location of one SD-WAN site?
      instructions:
      - text: Get SD-WAN site {site_id}.
        slots:
          site_id: path.site_id
      - text: Show the configuration of SD-WAN site {site_id}.
        slots:
          site_id: path.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sdwan/config/v1/sites/{site_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an SD-WAN site
      effect: write
      questions:
      - How do I change the address or tags of an SD-WAN site?
      - Can I disable an SD-WAN site by changing its admin state?
      instructions:
      - text: Rename SD-WAN site {site_id} to {name}.
        slots:
          site_id: path.site_id
          name: requestBody.name
      - text: Set the admin state of SD-WAN site {site_id} ({name}) to {admin_state}.
        slots:
          site_id: path.site_id
          name: requestBody.name
          admin_state: requestBody.admin_state
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sdwan/config/v1/sites/{site_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an SD-WAN site
      effect: destructive
      questions:
      - What happens to associated configuration when I delete an SD-WAN site?
      - Can I remove a closed branch from SD-WAN?
      instructions:
      - text: Delete SD-WAN site {site_id} and its configuration.
        slots:
          site_id: path.site_id
      - text: Remove SD-WAN site {site_id} from the tenant.
        slots:
          site_id: path.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites'].get
  update:
    x-apievangelist-phrasing:
      intent: List sites with claims and resolution history
      effect: read
      questions:
      - Which sites are still unclaimed, and what is their resolution history?
      - Can I filter sites by site group or claim status?
      instructions:
      - text: List sites in site group {site-group}.
        slots:
          site-group: query.site-group
      - text: Show sites with claim status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk-create sites all-or-nothing
      effect: write
      questions:
      - Can I create several sites at once and have none created if one fails validation?
      - What gets validated when I bulk-create sites?
      instructions:
      - text: 'Create these sites in one all-or-nothing batch: {sites}.'
        slots:
          sites: requestBody.sites
      - text: Bulk-create sites {sites} and create none if any fails validation.
        slots:
          sites: requestBody.sites
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a site with its claims
      effect: read
      questions:
      - Who has claimed a particular site and how was it resolved?
      - Can I fetch one site by UUID with its claim history?
      instructions:
      - text: Get site {id} with its claims and resolution history.
        slots:
          id: path.id
      - text: Show who claimed site {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an unclaimed site
      effect: write
      questions:
      - Why can't I update a site that's already been claimed?
      - Can I move an unclaimed site to a different site group?
      instructions:
      - text: Move site {id} into site group {site_group}.
        slots:
          id: path.id
          site_group: requestBody.site_group
      - text: Update the property values of site {id} to {property_values}.
        slots:
          id: path.id
          property_values: requestBody.property_values
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a site, optionally forcing it
      effect: destructive
      questions:
      - Can I delete a site that has already been claimed?
      - What does the force option do when removing a site?
      instructions:
      - text: Delete site {id}.
        slots:
          id: path.id
      - text: Force-delete claimed site {id} with force {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'