Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Log Forwarding Profiles API

10 actions 10 updates phrasing extends openapi/palo-alto-networks-log-forwarding-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 10

$.info
$.paths['/log-forwarding-profiles'].get
$.paths['/log-forwarding-profiles'].post
$.paths['/log-forwarding-profiles/{id}'].get
$.paths['/log-forwarding-profiles/{id}'].put
$.paths['/log-forwarding-profiles/{id}'].delete
$.paths['/log-forwarding-profiles/{profile_id}'].get
$.paths['/log-forwarding-profiles/{profile_id}'].put
$.paths['/log-forwarding-profiles/{profile_id}'].delete
$.paths['/log-forwarding-profiles/{profile_id}/status'].get

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 Palo Alto Networks Log Forwarding Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-log-forwarding-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: 9
- target: $.paths['/log-forwarding-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List log forwarding profiles
      effect: read
      questions:
      - Which log forwarding profiles are defined in a given configuration folder?
      - Can I list log forwarding profiles scoped to one snippet or device?
      instructions:
      - text: List log forwarding profiles in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the log forwarding profile named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/log-forwarding-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a log forwarding profile with match list
      effect: write
      questions:
      - How do I create a log forwarding profile with a match list of log types and filters?
      - Can a new log forwarding profile include a description?
      instructions:
      - text: Create log forwarding profile {name} with match list {match_list}.
        slots:
          name: requestBody.name
          match_list: requestBody.match_list
      - text: Add a log forwarding profile {name} described as {description} using match list {match_list}.
        slots:
          name: requestBody.name
          description: requestBody.description
          match_list: requestBody.match_list
      method: generated
      generated: '2026-09-26'
- target: $.paths['/log-forwarding-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a log forwarding profile's match list config
      effect: read
      questions:
      - What match list is configured on an existing log forwarding profile configuration object?
      - Can I fetch a log forwarding profile configuration resource by UUID?
      instructions:
      - text: Get the match list config of log forwarding profile object {id}.
        slots:
          id: path.id
      - text: Show log forwarding configuration resource {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/log-forwarding-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a log forwarding profile's match list
      effect: write
      questions:
      - Can I replace the match list on an existing log forwarding configuration object?
      - Is renaming a log forwarding config resource by UUID supported?
      instructions:
      - text: Update log forwarding config object {id} with name {name} and match list {match_list}.
        slots:
          id: path.id
          name: requestBody.name
          match_list: requestBody.match_list
      - text: Replace the match list on log forwarding resource {id} named {name} with {match_list}.
        slots:
          id: path.id
          name: requestBody.name
          match_list: requestBody.match_list
      method: generated
      generated: '2026-09-26'
- target: $.paths['/log-forwarding-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a log forwarding configuration object
      effect: destructive
      questions:
      - Can I delete a log forwarding profile configuration resource by its UUID?
      - Is removing a match-list log forwarding object permanent?
      instructions:
      - text: Delete log forwarding configuration object {id}.
        slots:
          id: path.id
      - text: Remove the match-list log forwarding resource {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/log-forwarding-profiles/{profile_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a log forwarding profile's log types
      effect: read
      questions:
      - Which log types does a particular log forwarding profile send?
      - Is a given log forwarding profile currently enabled?
      instructions:
      - text: Get full details for log forwarding profile {profile_id}, including its log types.
        slots:
          profile_id: path.profile_id
      - text: Show whether log forwarding profile {profile_id} is enabled.
        slots:
          profile_id: path.profile_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/log-forwarding-profiles/{profile_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a log forwarding profile's log types
      effect: write
      questions:
      - Can I change which log types a forwarding profile includes?
      - Is it possible to disable a log forwarding profile without deleting it?
      instructions:
      - text: Set log forwarding profile {profile_id} named {name} to forward log types {log_types}.
        slots:
          profile_id: path.profile_id
          name: requestBody.name
          log_types: requestBody.log_types
      - text: Update forwarding profile {profile_id} as {name} with log types {log_types} and enabled {enabled}.
        slots:
          profile_id: path.profile_id
          name: requestBody.name
          log_types: requestBody.log_types
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/log-forwarding-profiles/{profile_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a log forwarding profile and its destinations
      effect: destructive
      questions:
      - Does deleting a log forwarding profile also remove all its destinations?
      - Can I tear down a forwarding profile together with every destination it delivers to?
      instructions:
      - text: Delete log forwarding profile {profile_id} and all its destinations.
        slots:
          profile_id: path.profile_id
      - text: Remove forwarding profile {profile_id} along with its destinations.
        slots:
          profile_id: path.profile_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/log-forwarding-profiles/{profile_id}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check log forwarding delivery health
      effect: read
      questions:
      - Are logs actually reaching each destination of my forwarding profile?
      - When was the last successful log delivery, and how many errors occurred?
      instructions:
      - text: Get the operational status of log forwarding profile {profile_id}.
        slots:
          profile_id: path.profile_id
      - text: Check destination connectivity and error counts for forwarding profile {profile_id}.
        slots:
          profile_id: path.profile_id
      method: generated
      generated: '2026-09-26'