Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Syslog Profiles API

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

$.paths['/logging-service/logforwarding/v1/syslog-profiles'].post

$.paths['/logging-service/logforwarding/v1/syslog-profiles/{profileId}'].get

$.paths['/logging-service/logforwarding/v1/syslog-profiles/{profileId}'].put

$.paths['/logging-service/logforwarding/v1/syslog-profiles/{profileId}'].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 Syslog Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-syslogprofiles-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['/logging-service/logforwarding/v1/syslog-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List syslog forwarding profiles
      effect: read
      questions:
      - What syslog profiles do I have for log forwarding?
      - Can I list syslog profiles filtered by status?
      instructions:
      - text: List all syslog profiles.
      - text: List syslog profiles with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/logging-service/logforwarding/v1/syslog-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a syslog forwarding profile
      effect: write
      questions:
      - How do I start sending logs to my syslog server?
      - Which log types can a new syslog profile forward?
      instructions:
      - text: Create a syslog profile sending {logtypes} logs to {destination}.
        slots:
          logtypes: requestBody.logtypes
          destination: requestBody.destination
      - text: Forward {logtypes} to syslog server {destination}.
        slots:
          logtypes: requestBody.logtypes
          destination: requestBody.destination
      method: generated
      generated: '2026-09-26'
- target: $.paths['/logging-service/logforwarding/v1/syslog-profiles/{profileId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a syslog profile
      effect: read
      questions:
      - How can I see one syslog profile and its etag?
      - Where do I get the etag needed to update a syslog profile?
      instructions:
      - text: Get syslog profile {profileId}.
        slots:
          profileId: path.profileId
      - text: Fetch syslog profile {profileId} and its etag.
        slots:
          profileId: path.profileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/logging-service/logforwarding/v1/syslog-profiles/{profileId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a syslog profile
      effect: write
      questions:
      - Can I change where an existing syslog profile sends logs?
      - Is it possible to change a syslog profile's profile type?
      instructions:
      - text: Update syslog profile {profileId} to send {logtypes} to {destination}.
        slots:
          profileId: path.profileId
          logtypes: requestBody.logtypes
          destination: requestBody.destination
      - text: 'Change syslog profile {profileId} using etag {etag}: destination {destination}, log types {logtypes}.'
        slots:
          profileId: path.profileId
          etag: header.etag
          destination: requestBody.destination
          logtypes: requestBody.logtypes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/logging-service/logforwarding/v1/syslog-profiles/{profileId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a syslog profile
      effect: destructive
      questions:
      - How do I stop forwarding logs by deleting a syslog profile?
      - Can a syslog profile be removed by its ID?
      instructions:
      - text: Delete syslog profile {profileId}.
        slots:
          profileId: path.profileId
      - text: Remove the syslog forwarding profile {profileId}.
        slots:
          profileId: path.profileId
      method: generated
      generated: '2026-09-26'