Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Security Services File Blocking Profiles API

11 actions 11 updates phrasing extends openapi/palo-alto-networks-file-blocking-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 11

$.info
$.paths['/file-blocking-profiles'].get
$.paths['/file-blocking-profiles'].post
$.paths['/file-blocking-profiles/{id}'].get
$.paths['/file-blocking-profiles/{id}'].put
$.paths['/file-blocking-profiles/{id}'].delete
$.paths['/sse/config/v1/file-blocking-profiles'].get
$.paths['/sse/config/v1/file-blocking-profiles'].post
$.paths['/sse/config/v1/file-blocking-profiles/{id}'].get
$.paths['/sse/config/v1/file-blocking-profiles/{id}'].put
$.paths['/sse/config/v1/file-blocking-profiles/{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 Security Services File Blocking Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-file-blocking-profiles-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: 10
- target: $.paths['/file-blocking-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List file blocking profiles
      effect: read
      questions:
      - Which file blocking profiles are configured in my folders?
      - Can I find a file blocking profile by name within a snippet?
      instructions:
      - text: List file blocking profiles in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the file blocking profile named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/file-blocking-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a file blocking profile
      effect: write
      questions:
      - How do I create a profile that blocks certain file types from being uploaded or downloaded?
      - Can I define file blocking rules when I create the profile?
      instructions:
      - text: Create file blocking profile {name}.
        slots:
          name: requestBody.name
      - text: Create file blocking profile {name} with rules {rules}.
        slots:
          name: requestBody.name
          rules: requestBody.rules
      method: generated
      generated: '2026-09-26'
- target: $.paths['/file-blocking-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a file blocking profile
      effect: read
      questions:
      - What file types does a specific file blocking profile block?
      - Can I fetch one file blocking profile by ID?
      instructions:
      - text: Show file blocking profile {id}.
        slots:
          id: path.id
      - text: Get the rules in file blocking profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/file-blocking-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a file blocking profile
      effect: write
      questions:
      - Can I change the rules on a file blocking profile I already have?
      - Is it possible to rename an existing file blocking profile?
      instructions:
      - text: Replace the rules on file blocking profile {id} with {rules}, keeping name {name}.
        slots:
          id: path.id
          rules: requestBody.rules
          name: requestBody.name
      - text: Rename file blocking profile {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/file-blocking-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a file blocking profile
      effect: destructive
      questions:
      - How do I delete a file blocking profile?
      - Will removing a file blocking profile stop blocking those file types?
      instructions:
      - text: Delete file blocking profile {id}.
        slots:
          id: path.id
      - text: Remove the unused file blocking profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/file-blocking-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List file blocking profiles
      effect: read
      questions:
      - What file blocking profiles are set up in a folder?
      - Can I look for a file blocking profile by name?
      instructions:
      - text: List file blocking profiles in folder {folder} through the SSE config v1 path.
        slots:
          folder: query.folder
      - text: Find file blocking profile {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/file-blocking-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a file blocking profile
      effect: write
      questions:
      - How do I block users from uploading or downloading certain file types?
      - Can a new file blocking profile contain multiple rules?
      instructions:
      - text: Create file blocking profile {name} in folder {folder}.
        slots:
          name: requestBody.name
          folder: query.folder
      - text: Add file blocking profile {name} with rules {rules} to {folder}.
        slots:
          name: requestBody.name
          rules: requestBody.rules
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/file-blocking-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a file blocking profile
      effect: read
      questions:
      - Which file types does a specific file blocking profile block?
      - Can I fetch a file blocking profile by ID?
      instructions:
      - text: Get file blocking profile {id}.
        slots:
          id: path.id
      - text: Show the rules in file blocking profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/file-blocking-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a file blocking profile
      effect: write
      questions:
      - Can I add a new file type rule to an existing file blocking profile?
      - How do I rename a file blocking profile?
      instructions:
      - text: Update file blocking profile {id} with rules {rules}.
        slots:
          id: path.id
          rules: requestBody.rules
      - text: Rename file blocking profile {id} to {name} via the SSE config v1 path.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/file-blocking-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a file blocking profile
      effect: destructive
      questions:
      - How do I remove a file blocking profile I no longer need?
      - Is deleting a file blocking profile permanent?
      instructions:
      - text: Delete file blocking profile {id} using the SSE config v1 endpoint.
        slots:
          id: path.id
      - text: Remove the file blocking profile with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'