Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Objects Syslog Server Profiles API

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

$.paths['/syslog-server-profiles'].post

$.paths['/syslog-server-profiles/{id}'].get

$.paths['/syslog-server-profiles/{id}'].put

$.paths['/syslog-server-profiles/{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 Objects Syslog Server Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-syslog-server-profiles-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['/syslog-server-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List syslog server profiles
      effect: read
      questions:
      - Which syslog server profiles are set up for log forwarding?
      - Can I list syslog profiles defined in a particular folder?
      instructions:
      - text: List syslog server profiles in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the syslog server profile named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/syslog-server-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a syslog server profile
      effect: write
      questions:
      - How do I forward firewall logs to my own syslog server?
      - Can one syslog profile send to more than one server?
      instructions:
      - text: Create syslog profile {name} with ID {id} sending to servers {servers}.
        slots:
          name: requestBody.name
          id: requestBody.id
          servers: requestBody.server
      - text: Add syslog server profile {name} for servers {servers} using format {format}.
        slots:
          name: requestBody.name
          servers: requestBody.server
          format: requestBody.format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/syslog-server-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a syslog server profile
      effect: read
      questions:
      - Where can I see the servers in one syslog profile?
      - What log format does a given syslog server profile use?
      instructions:
      - text: Get syslog server profile {id}.
        slots:
          id: path.id
      - text: Show the servers and format of syslog profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/syslog-server-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a syslog server profile
      effect: write
      questions:
      - How do I change the destination servers of a syslog profile?
      - Can I switch an existing syslog profile to a different log format?
      instructions:
      - text: Update syslog profile {id} to send to servers {servers}.
        slots:
          id: path.id
          servers: requestBody.server
      - text: Change the format of syslog server profile {id} to {format}.
        slots:
          id: path.id
          format: requestBody.format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/syslog-server-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a syslog server profile
      effect: destructive
      questions:
      - Can I stop forwarding logs by removing a syslog profile?
      - Is deleting a syslog server profile permanent?
      instructions:
      - text: Delete syslog server profile {id}.
        slots:
          id: path.id
      - text: Remove the syslog profile with UUID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'