Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Security Services DoS Protection Profiles API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-dos-protection-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['/dos-protection-profiles'].get
$.paths['/dos-protection-profiles'].post
$.paths['/dos-protection-profiles/{id}'].get
$.paths['/dos-protection-profiles/{id}'].put
$.paths['/dos-protection-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 DoS Protection Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-dos-protection-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['/dos-protection-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List DoS protection profiles
      effect: read
      questions:
      - Which DoS protection profiles are configured in a folder?
      - Can I look up DoS profiles by name within a snippet or device?
      instructions:
      - text: List DoS protection profiles in folder {folder}.
        slots:
          folder: query.folder
      - text: Find DoS protection profiles named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dos-protection-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a DoS protection profile
      effect: write
      questions:
      - How do I create a DoS protection profile with flood thresholds?
      - Can I make an aggregate or classified DoS profile?
      instructions:
      - text: Create a {type} DoS protection profile named {name}.
        slots:
          type: requestBody.type
          name: requestBody.name
      - text: Add DoS profile {name} of type {type} with flood settings {flood}.
        slots:
          name: requestBody.name
          type: requestBody.type
          flood: requestBody.flood
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dos-protection-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a DoS protection profile
      effect: read
      questions:
      - How do I view one DoS protection profile's flood and resource settings?
      - What does a specific DoS profile contain?
      instructions:
      - text: Get DoS protection profile {id}.
        slots:
          id: path.id
      - text: Show DoS profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dos-protection-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a DoS protection profile
      effect: write
      questions:
      - Can I change the flood protection thresholds on an existing DoS profile?
      - How do I edit a DoS protection profile's resource limits?
      instructions:
      - text: Update DoS profile {id} to name {name}, type {type}.
        slots:
          id: path.id
          name: requestBody.name
          type: requestBody.type
      - text: Set flood protection on DoS profile {id} ({name}, {type}) to {flood}.
        slots:
          id: path.id
          name: requestBody.name
          type: requestBody.type
          flood: requestBody.flood
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dos-protection-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a DoS protection profile
      effect: destructive
      questions:
      - How do I delete a DoS protection profile?
      - Can I remove an unused DoS profile?
      instructions:
      - text: Delete DoS protection profile {id}.
        slots:
          id: path.id
      - text: Remove DoS profile {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'