Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Device Settings General Settings API

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

$.paths['/general-settings'].post

$.paths['/general-settings/{id}'].get

$.paths['/general-settings/{id}'].put

$.paths['/general-settings/{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 Settings General Settings API
  version: 1.0.0
extends: openapi/palo-alto-networks-general-settings-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['/general-settings'].get
  update:
    x-apievangelist-phrasing:
      intent: List general settings
      effect: read
      questions:
      - What general settings are configured for a folder or device?
      - Can I see the general settings defined in a snippet?
      instructions:
      - text: List the general settings for folder {folder}.
        slots:
          folder: query.folder
      - text: Show general settings on device {device}.
        slots:
          device: query.device
      method: generated
      generated: '2026-09-26'
- target: $.paths['/general-settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create general settings
      effect: write
      questions:
      - How do I create a general settings object?
      - Can I define new general settings from scratch?
      instructions:
      - text: Create general settings with values {general}.
        slots:
          general: requestBody.general
      - text: Create a new general settings object.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/general-settings/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get general settings by ID
      effect: read
      questions:
      - What's in one specific general settings object?
      - Can I fetch general settings by their ID?
      instructions:
      - text: Get general settings {id}.
        slots:
          id: path.id
      - text: Show me the general settings object {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/general-settings/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update general settings
      effect: write
      questions:
      - Can I change existing general settings?
      - What's the call to edit a general settings object I already have?
      instructions:
      - text: Update general settings {id} with {general}.
        slots:
          id: path.id
          general: requestBody.general
      - text: Change the values in general settings {id} to {general}.
        slots:
          id: path.id
          general: requestBody.general
      method: generated
      generated: '2026-09-26'
- target: $.paths['/general-settings/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete general settings
      effect: destructive
      questions:
      - How do I remove a general settings object?
      - Can I delete general settings by ID?
      instructions:
      - text: Delete general settings {id}.
        slots:
          id: path.id
      - text: Remove general settings object {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'