# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Network Services QoS Rules API
  version: 1.0.0
extends: openapi/palo-alto-networks-qos-rules-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: 8
- target: $.paths['/qos-policy-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List QoS policy rules
      effect: read
      questions:
      - What QoS policy rules are configured in a folder?
      - Can I see pre-rules versus post-rules for QoS?
      instructions:
      - text: List the {position} QoS policy rules in folder {folder}.
        slots:
          position: query.position
          folder: query.folder
      - text: Find QoS rules named {name} at position {position}.
        slots:
          name: query.name
          position: query.position
      method: generated
      generated: '2026-09-26'
- target: $.paths['/qos-policy-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a QoS policy rule
      effect: write
      questions:
      - How do I add a rule that prioritizes traffic by QoS class?
      - Can a new QoS rule match on DSCP or TOS values?
      instructions:
      - text: Create a {position} QoS rule {name} with action {action}.
        slots:
          position: query.position
          name: requestBody.name
          action: requestBody.action
      - text: Add QoS rule {name} using action {action} on schedule {schedule} as a {position} rule.
        slots:
          name: requestBody.name
          action: requestBody.action
          schedule: requestBody.schedule
          position: query.position
      method: generated
      generated: '2026-09-26'
- target: $.paths['/qos-policy-rules/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a QoS policy rule
      effect: read
      questions:
      - What does a particular QoS rule do?
      - Can I look up one QoS rule by its ID?
      instructions:
      - text: Show QoS rule {id}.
        slots:
          id: path.id
      - text: Get the configuration of QoS policy rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/qos-policy-rules/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a QoS policy rule
      effect: write
      questions:
      - How do I change the action on an existing QoS rule?
      - Can I change the schedule of a QoS rule I already created?
      instructions:
      - text: Change QoS rule {id} to action {action}, keeping name {name}.
        slots:
          id: path.id
          action: requestBody.action
          name: requestBody.name
      - text: Update the description of QoS rule {id} named {name} to {description}.
        slots:
          id: path.id
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/qos-policy-rules/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a QoS policy rule
      effect: destructive
      questions:
      - How do I remove a QoS rule?
      - Can I delete a QoS policy rule by ID?
      instructions:
      - text: Delete QoS rule {id}.
        slots:
          id: path.id
      - text: Remove QoS policy rule {id} from the rulebase.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/qos-policy-rules/{id}:move'].post
  update:
    x-apievangelist-phrasing:
      intent: Reorder a QoS policy rule
      effect: write
      questions:
      - How do I move a QoS rule to the top or bottom of the rulebase?
      - Can I place a QoS rule before or after another specific rule?
      instructions:
      - text: Move QoS rule {id} to {destination} of the {rulebase} rulebase.
        slots:
          id: path.id
          destination: requestBody.destination
          rulebase: requestBody.rulebase
      - text: Place QoS rule {id} {destination} rule {destination_rule} in the {rulebase} rulebase.
        slots:
          id: path.id
          destination: requestBody.destination
          destination_rule: requestBody.destination_rule
          rulebase: requestBody.rulebase
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sdwan/config/v1/policies/qos-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List SD-WAN QoS rules
      effect: read
      questions:
      - Which QoS rules prioritize traffic on my SD-WAN links?
      - What bandwidth limits are set by my existing QoS rules?
      instructions:
      - text: List the QoS rules in my SD-WAN tenant.
      - text: Show {limit} QoS rules starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sdwan/config/v1/policies/qos-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an SD-WAN QoS rule
      effect: write
      questions:
      - How do I prioritize an application's traffic over my WAN links?
      - Can I cap upload and download bandwidth in a new QoS rule?
      instructions:
      - text: Create QoS rule {name} with priority {priority} for app filters {app_filters}.
        slots:
          name: requestBody.name
          priority: requestBody.priority
          app_filters: requestBody.app_filters
      - text: Add QoS rule {name} limiting bandwidth to {bandwidth_limit_up} up and {bandwidth_limit_down} down.
        slots:
          name: requestBody.name
          bandwidth_limit_up: requestBody.bandwidth_limit_up
          bandwidth_limit_down: requestBody.bandwidth_limit_down
      method: generated
      generated: '2026-10-01'