Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for v2 Peripherals API

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

$.paths['/v2/api/peripherals'].post

$.paths['/v2/api/peripherals/{resourceId}'].get

$.paths['/v2/api/peripherals/{resourceId}'].put

$.paths['/v2/api/peripherals/{resourceId}'].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 v2 Peripherals API
  version: 1.0.0
extends: openapi/palo-alto-networks-peripherals-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['/v2/api/peripherals'].get
  update:
    x-apievangelist-phrasing:
      intent: List peripheral devices
      effect: read
      questions:
      - Which peripheral devices are registered for my tenant?
      - Can I filter peripherals by type and include their groups?
      instructions:
      - text: List peripherals of type {peripheral_type}.
        slots:
          peripheral_type: query.peripheral-type
      - text: Show page {page} of my peripherals with groups included {with_groups}.
        slots:
          page: query.page
          with_groups: query.with-groups
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/peripherals'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a peripheral device
      effect: write
      questions:
      - How do I register a new peripheral device?
      - What type values can a new peripheral have?
      instructions:
      - text: Create a peripheral of type {type}.
        slots:
          type: requestBody.type
      - text: Register a new {type} peripheral for my tenant.
        slots:
          type: requestBody.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/peripherals/{resourceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a peripheral device
      effect: read
      questions:
      - What are the details of one peripheral device?
      - Can I fetch a peripheral by its resource ID?
      instructions:
      - text: Get peripheral {resource_id}.
        slots:
          resource_id: path.resourceId
      - text: Show me the details of peripheral device {resource_id}.
        slots:
          resource_id: path.resourceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/peripherals/{resourceId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a peripheral device
      effect: write
      questions:
      - Can I change an existing peripheral's type?
      - Does updating a peripheral replace the whole record?
      instructions:
      - text: Replace peripheral {resource_id} with type {type}.
        slots:
          resource_id: path.resourceId
          type: requestBody.type
      - text: Update peripheral device {resource_id} to be a {type}.
        slots:
          resource_id: path.resourceId
          type: requestBody.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/peripherals/{resourceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a peripheral device
      effect: destructive
      questions:
      - How do I remove a peripheral device?
      - Can I delete a peripheral by its ID?
      instructions:
      - text: Delete peripheral {resource_id}.
        slots:
          resource_id: path.resourceId
      - text: Remove peripheral device {resource_id} from my tenant.
        slots:
          resource_id: path.resourceId
      method: generated
      generated: '2026-09-26'