# 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 Rules API
  version: 1.0.0
extends: openapi/palo-alto-networks-dos-protection-rules-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-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List DoS protection rules
      effect: read
      questions:
      - Which DoS protection rules are in a folder?
      - Can I look up a DoS protection rule by name?
      instructions:
      - text: List DoS protection rules in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the DoS protection rule named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dos-protection-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a DoS protection rule
      effect: write
      questions:
      - How do I protect a service from floods with a new DoS protection rule?
      - What source, zones and profile does a DoS protection rule need?
      instructions:
      - text: Create DoS protection rule {name} from zone {from} to zone {to} for source {source}, service {service}, protection {protection}.
        slots:
          name: requestBody.name
          from: requestBody.from
          to: requestBody.to
          source: requestBody.source
          service: requestBody.service
          protection: requestBody.protection
      - text: Add DoS rule {name} with action {action} on schedule {schedule}.
        slots:
          name: requestBody.name
          action: requestBody.action
          schedule: requestBody.schedule
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dos-protection-rules/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a DoS protection rule
      effect: read
      questions:
      - What zones and protection profile does a given DoS rule use?
      - Can I read one DoS protection rule by ID?
      instructions:
      - text: Get DoS protection rule {id}.
        slots:
          id: path.id
      - text: Show zones and protection for DoS rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dos-protection-rules/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a DoS protection rule
      effect: write
      questions:
      - Can I disable an existing DoS protection rule without deleting it?
      - How do I change the protection profile on a DoS rule?
      instructions:
      - text: Disable DoS protection rule {id} by setting disabled to {disabled}.
        slots:
          id: path.id
          disabled: requestBody.disabled
      - text: Update DoS rule {id} to use protection {protection}.
        slots:
          id: path.id
          protection: requestBody.protection
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dos-protection-rules/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a DoS protection rule
      effect: destructive
      questions:
      - How do I remove a DoS protection rule?
      - Does deleting a DoS rule take effect before a config push?
      instructions:
      - text: Delete DoS protection rule {id}.
        slots:
          id: path.id
      - text: Remove the DoS rule with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'