Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Device Onboarding Onboarding Rules API

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

$.info

$.paths['/onboarding-rules'].get

$.paths['/onboarding-rules'].post

$.paths['/onboarding-rules/{id}:move'].post

$.paths['/onboarding-rules/{id}'].get

$.paths['/onboarding-rules/{id}'].put

$.paths['/onboarding-rules/{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 Onboarding Rules API
  version: 1.0.0
extends: openapi/palo-alto-networks-onboarding-rules-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: 6
- target: $.paths['/onboarding-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List onboarding rules by priority
      effect: read
      questions:
      - Which onboarding rules are configured and in what order are they evaluated?
      - What onboarding rules do I have today?
      instructions:
      - text: List all onboarding rules in priority order.
      - text: Show my onboarding rules.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/onboarding-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an onboarding rule
      effect: write
      questions:
      - How do I automatically onboard devices that match certain criteria?
      - Can an onboarding rule resolve variables for a site group?
      instructions:
      - text: Create onboarding rule {name} of type {rule_type} for site group {site_group} matching {match_criteria} with actions {actions}.
        slots:
          name: requestBody.name
          rule_type: requestBody.rule_type
          site_group: requestBody.site_group
          match_criteria: requestBody.match_criteria
          actions: requestBody.actions
      - text: Add onboarding rule {name} for site group {site_group}, enabled {enable}.
        slots:
          name: requestBody.name
          site_group: requestBody.site_group
          enable: requestBody.enable
      method: generated
      generated: '2026-09-26'
- target: $.paths['/onboarding-rules/{id}:move'].post
  update:
    x-apievangelist-phrasing:
      intent: Reorder an onboarding rule
      effect: write
      questions:
      - Can I move an onboarding rule to the top of the list?
      - Can I place one onboarding rule right after another?
      instructions:
      - text: Move onboarding rule {id} to {position}.
        slots:
          id: path.id
          position: requestBody.position
      - text: Move rule {id} {position} rule {reference}.
        slots:
          id: path.id
          position: requestBody.position
          reference: requestBody.reference
      method: generated
      generated: '2026-09-26'
- target: $.paths['/onboarding-rules/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an onboarding rule
      effect: read
      questions:
      - What match criteria and actions does one onboarding rule use?
      - Can I look up an onboarding rule by its UUID?
      instructions:
      - text: Get onboarding rule {id}.
        slots:
          id: path.id
      - text: Show the criteria and actions of onboarding rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/onboarding-rules/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an onboarding rule
      effect: write
      questions:
      - How do I change the actions an existing onboarding rule performs?
      - Can I disable an onboarding rule without deleting it?
      instructions:
      - text: Update onboarding rule {id} with match criteria {match_criteria} and actions {actions}.
        slots:
          id: path.id
          match_criteria: requestBody.match_criteria
          actions: requestBody.actions
      - text: Set enable to {enable} on existing onboarding rule {id}.
        slots:
          id: path.id
          enable: requestBody.enable
      method: generated
      generated: '2026-09-26'
- target: $.paths['/onboarding-rules/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an onboarding rule
      effect: destructive
      questions:
      - Can I get rid of an onboarding rule?
      - Is deleting an onboarding rule permanent?
      instructions:
      - text: Delete onboarding rule {id}.
        slots:
          id: path.id
      - text: Remove the onboarding rule with UUID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'