Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Device Settings Session Settings API

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

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

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

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

$.paths['/session-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 Session Settings API
  version: 1.0.0
extends: openapi/palo-alto-networks-session-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['/session-settings'].get
  update:
    x-apievangelist-phrasing:
      intent: List session settings
      effect: read
      questions:
      - What session settings are configured in a folder?
      - Can I see session settings defined on a specific device?
      instructions:
      - text: List session settings in folder {folder}.
        slots:
          folder: query.folder
      - text: Show the session settings on device {device}.
        slots:
          device: query.device
      method: generated
      generated: '2026-09-26'
- target: $.paths['/session-settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create session settings
      effect: write
      questions:
      - How do I define new firewall session settings?
      - Can I create session settings from a settings object?
      instructions:
      - text: Create session settings with {session_settings}.
        slots:
          session_settings: requestBody.session_settings
      - text: Add a new session settings object using {session_settings}.
        slots:
          session_settings: requestBody.session_settings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/session-settings/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get session settings
      effect: read
      questions:
      - Can I view one session settings object by UUID?
      - What values does a particular session settings entry hold?
      instructions:
      - text: Get session settings {id}.
        slots:
          id: path.id
      - text: Show the session settings object {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/session-settings/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update session settings
      effect: write
      questions:
      - How do I change existing session settings?
      - Can I edit a session settings object in place?
      instructions:
      - text: Update session settings {id} to {session_settings}.
        slots:
          id: path.id
          session_settings: requestBody.session_settings
      - text: Change existing session settings {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/session-settings/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete session settings
      effect: destructive
      questions:
      - Is there a way to remove a session settings object?
      - Can I delete session settings by UUID?
      instructions:
      - text: Delete session settings {id}.
        slots:
          id: path.id
      - text: Remove the session settings object {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'