Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Email Profiles API

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

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

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

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

$.paths['/logging-service/logforwarding/v1/email-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 Email Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-emailprofiles-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/email-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List log forwarding email profiles
      effect: read
      questions:
      - Which email profiles are set up to forward logs, and what are their profile IDs?
      - Can I list only email profiles with a certain status?
      instructions:
      - text: List all log forwarding email profiles.
      - text: Show up to {resultSize} email profiles with status {status}.
        slots:
          resultSize: query.resultSize
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/logging-service/logforwarding/v1/email-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a log forwarding email profile
      effect: write
      questions:
      - How do I have certain logs emailed to an address automatically?
      - Can I choose which log types get sent when I create an email profile?
      instructions:
      - text: Create an email profile sending {logtypes} logs to {destination}.
        slots:
          logtypes: requestBody.logtypes
          destination: requestBody.destination
      - text: Set up log forwarding by email to recipient {destination} for log types {logtypes}.
        slots:
          destination: requestBody.destination
          logtypes: requestBody.logtypes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/logging-service/logforwarding/v1/email-profiles/{profileId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an email profile and its etag
      effect: read
      questions:
      - How do I get the etag I need before editing an email profile?
      - What recipients and log types does a given email profile have?
      instructions:
      - text: Get email profile {profileId}.
        slots:
          profileId: path.profileId
      - text: Fetch email profile {profileId} and return its etag.
        slots:
          profileId: path.profileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/logging-service/logforwarding/v1/email-profiles/{profileId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an email profile
      effect: write
      questions:
      - How do I change the recipient on an existing log email profile?
      - Which fields of an email profile can be changed, and is an etag required?
      instructions:
      - text: Update email profile {profileId} to send {logtypes} to {destination}.
        slots:
          profileId: path.profileId
          logtypes: requestBody.logtypes
          destination: requestBody.destination
      - text: Using etag {etag}, change email profile {profileId} recipient to {destination} for {logtypes}.
        slots:
          etag: header.etag
          profileId: path.profileId
          destination: requestBody.destination
          logtypes: requestBody.logtypes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/logging-service/logforwarding/v1/email-profiles/{profileId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an email profile
      effect: destructive
      questions:
      - How do I stop logs being emailed by deleting an email profile?
      - Can I delete an email profile by its profile ID?
      instructions:
      - text: Delete email profile {profileId}.
        slots:
          profileId: path.profileId
      - text: Remove the log forwarding email profile {profileId}.
        slots:
          profileId: path.profileId
      method: generated
      generated: '2026-09-26'