Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Quality of Service Policy Rules Qo S Policy Rules API

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

$.info
$.paths['/sse/config/v1/qos-policy-rules'].get
$.paths['/sse/config/v1/qos-policy-rules'].post
$.paths['/sse/config/v1/qos-policy-rules/{id}'].get
$.paths['/sse/config/v1/qos-policy-rules/{id}'].put
$.paths['/sse/config/v1/qos-policy-rules/{id}'].delete
$.paths['/sse/config/v1/qos-policy-rules/{id}:move'].post

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 Quality of Service Policy Rules Qo S Policy Rules API
  version: 1.0.0
extends: openapi/palo-alto-networks-qospolicyrules-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: 6
- target: $.paths['/sse/config/v1/qos-policy-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List QoS policy rules in a folder
      effect: read
      questions:
      - What quality of service rules are configured in a Prisma Access folder?
      - Can I list only pre or post QoS rules?
      instructions:
      - text: List QoS policy rules in folder {folder} at position {position}.
        slots:
          folder: query.folder
          position: query.position
      - text: Find the QoS rule named {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/qos-policy-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a QoS policy rule
      effect: write
      questions:
      - How do I prioritize traffic with a new QoS rule?
      - Can a QoS rule match on DSCP/ToS values or run on a schedule?
      instructions:
      - text: Create QoS rule {name} with action {action} in folder {folder} at {position}.
        slots:
          name: requestBody.name
          action: requestBody.action
          folder: query.folder
          position: query.position
      - text: Add QoS rule {name} in {folder} that runs on schedule {schedule}.
        slots:
          name: requestBody.name
          folder: query.folder
          schedule: requestBody.schedule
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/qos-policy-rules/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a QoS policy rule
      effect: read
      questions:
      - Where can I see a single QoS rule's settings?
      - What action and DSCP settings does a given QoS rule have?
      instructions:
      - text: Get QoS rule {id} in folder {folder}.
        slots:
          id: path.id
          folder: query.folder
      - text: Show the settings of QoS policy rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/qos-policy-rules/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a QoS policy rule
      effect: write
      questions:
      - How do I change the action of an existing QoS rule?
      - Can I update a QoS rule's schedule after it is 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} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/qos-policy-rules/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a QoS policy rule
      effect: destructive
      questions:
      - Can I remove a QoS rule I no longer need?
      - Is deleting a QoS policy rule immediate or does it need a push?
      instructions:
      - text: Delete QoS rule {id}.
        slots:
          id: path.id
      - text: Remove QoS policy rule {id} from the configuration.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/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 of the rulebase?
      - Can I place a QoS rule directly before or after another rule?
      instructions:
      - text: Move QoS rule {id} to the {destination} of the {rulebase} rulebase in {folder}.
        slots:
          id: path.id
          destination: requestBody.destination
          rulebase: requestBody.rulebase
          folder: query.folder
      - text: Place QoS rule {id} {destination} rule {other} in the {rulebase} rulebase of {folder}.
        slots:
          id: path.id
          destination: requestBody.destination
          other: requestBody.destination_rule
          rulebase: requestBody.rulebase
          folder: query.folder
      method: generated
      generated: '2026-09-26'