Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Device Settings Authentication Settings API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-authentication-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['/authentication-settings'].get
$.paths['/authentication-settings'].post
$.paths['/authentication-settings/{id}'].get
$.paths['/authentication-settings/{id}'].put
$.paths['/authentication-settings/{id}'].delete

OpenAPI Overlay

Raw ↑
# 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 Authentication Settings API
  version: 1.0.0
extends: openapi/palo-alto-networks-authentication-settings-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/authentication-settings'].get
  update:
    x-apievangelist-phrasing:
      intent: List GlobalProtect authentication settings
      effect: read
      questions:
      - Which GlobalProtect agent authentication settings are configured?
      - Can I look up a GlobalProtect authentication setting by name in a folder?
      instructions:
      - text: List GlobalProtect authentication settings.
      - text: Show GlobalProtect authentication settings for device {device} in folder {folder}.
        slots:
          device: query.device
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/authentication-settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a GlobalProtect authentication setting
      effect: write
      questions:
      - How do I add a new GlobalProtect authentication setting with its own ID?
      - What must a new GlobalProtect agent authentication setting include?
      instructions:
      - text: Create GlobalProtect authentication setting {id}.
        slots:
          id: requestBody.id
      - text: Add GlobalProtect auth setting {id} with authentication configuration {authentication}.
        slots:
          id: requestBody.id
          authentication: requestBody.authentication
      method: generated
      generated: '2026-10-01'
- target: $.paths['/authentication-settings/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get device authentication settings
      effect: read
      questions:
      - What authentication is configured in a specific device authentication settings object?
      - Can I retrieve device authentication settings by UUID?
      instructions:
      - text: Get device authentication settings {id}.
        slots:
          id: path.id
      - text: Show the authentication configured in settings object {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/authentication-settings/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update device authentication settings
      effect: write
      questions:
      - Can I change the authentication used by an existing device settings object?
      - Is it possible to update device authentication settings in place?
      instructions:
      - text: Update device authentication settings {id} to use {authentication}.
        slots:
          id: path.id
          authentication: requestBody.authentication
      - text: Replace the auth config on settings {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/authentication-settings/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete device authentication settings
      effect: destructive
      questions:
      - Can I delete a device authentication settings object?
      - What happens to devices when their authentication settings are removed?
      instructions:
      - text: Delete device authentication settings {id}.
        slots:
          id: path.id
      - text: Remove the device auth settings object {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'