Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Network Services QoS Profiles API

11 actions 11 updates phrasing extends openapi/palo-alto-networks-qos-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['/qos-profiles'].get
$.paths['/qos-profiles'].post
$.paths['/qos-profiles/{id}'].get
$.paths['/qos-profiles/{id}'].put
$.paths['/qos-profiles/{id}'].delete
$.paths['/sse/config/v1/qos-profiles'].get
$.paths['/sse/config/v1/qos-profiles'].post
$.paths['/sse/config/v1/qos-profiles/{id}'].get
$.paths['/sse/config/v1/qos-profiles/{id}'].put
$.paths['/sse/config/v1/qos-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 Network Services QoS Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-qos-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['/qos-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List QoS profiles
      effect: read
      questions:
      - Which QoS profiles are configured in a folder?
      - Can I find a QoS profile by name in a snippet?
      instructions:
      - text: List QoS profiles in folder {folder}.
        slots:
          folder: query.folder
      - text: Find QoS profile {name} in snippet {snippet}.
        slots:
          name: query.name
          snippet: query.snippet
      method: generated
      generated: '2026-09-26'
- target: $.paths['/qos-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a QoS profile
      effect: write
      questions:
      - How do I create a QoS profile that caps aggregate bandwidth?
      - Can a new QoS profile set bandwidth per traffic class?
      instructions:
      - text: Create QoS profile {name}.
        slots:
          name: requestBody.name
      - text: Create QoS profile {name} with aggregate bandwidth {aggregate_bandwidth}.
        slots:
          name: requestBody.name
          aggregate_bandwidth: requestBody.aggregate_bandwidth
      method: generated
      generated: '2026-09-26'
- target: $.paths['/qos-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a QoS profile
      effect: read
      questions:
      - What bandwidth limits are in a particular QoS profile?
      - Can I read one QoS profile by UUID?
      instructions:
      - text: Get QoS profile {id}.
        slots:
          id: path.id
      - text: Show the bandwidth settings of QoS profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/qos-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a QoS profile
      effect: write
      questions:
      - How do I change the class bandwidth on an existing QoS profile?
      - Can I raise the aggregate bandwidth of a QoS profile I already have?
      instructions:
      - text: Update QoS profile {id} with class bandwidth {class_bandwidth_type}.
        slots:
          id: path.id
          class_bandwidth_type: requestBody.class_bandwidth_type
      - text: Set aggregate bandwidth {aggregate_bandwidth} on existing QoS profile {id}.
        slots:
          id: path.id
          aggregate_bandwidth: requestBody.aggregate_bandwidth
      method: generated
      generated: '2026-09-26'
- target: $.paths['/qos-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a QoS profile
      effect: destructive
      questions:
      - Is there a way to remove a QoS profile?
      - Can I delete an unused QoS profile by its UUID?
      instructions:
      - text: Delete QoS profile {id}.
        slots:
          id: path.id
      - text: Remove the QoS profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/qos-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List QoS profiles
      effect: read
      questions:
      - Which quality of service profiles exist in a Prisma Access folder?
      - Can I search QoS profiles by name?
      instructions:
      - text: List QoS profiles in folder {folder} through the SSE config v1 path.
        slots:
          folder: query.folder
      - text: Find the QoS profile named {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/qos-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a QoS profile
      effect: write
      questions:
      - How do I create a QoS profile with an aggregate bandwidth limit?
      - Can I choose the class bandwidth type on a new QoS profile?
      instructions:
      - text: Create QoS profile {name} in folder {folder}.
        slots:
          name: requestBody.name
          folder: query.folder
      - text: In folder {folder}, add QoS profile {name} capped at aggregate bandwidth {aggregate_bandwidth}.
        slots:
          name: requestBody.name
          folder: query.folder
          aggregate_bandwidth: requestBody.aggregate_bandwidth
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/qos-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a QoS profile
      effect: read
      questions:
      - What bandwidth settings does a specific QoS profile have?
      - Can I fetch one QoS profile by id?
      instructions:
      - text: Get QoS profile {id} in folder {folder}.
        slots:
          id: path.id
          folder: query.folder
      - text: Show bandwidth settings of QoS profile {id} from folder {folder}.
        slots:
          id: path.id
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/qos-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a QoS profile
      effect: write
      questions:
      - How do I change the aggregate bandwidth on an existing QoS profile?
      - Can I switch the class bandwidth type of a QoS profile?
      instructions:
      - text: Edit QoS profile {id} and name it {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set aggregate bandwidth {aggregate_bandwidth} on QoS profile {id} named {name}.
        slots:
          aggregate_bandwidth: requestBody.aggregate_bandwidth
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/qos-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a QoS profile
      effect: destructive
      questions:
      - Which call removes a QoS profile?
      - Is deleting a QoS profile permanent?
      instructions:
      - text: Delete QoS profile {id} using the SSE config v1 endpoint.
        slots:
          id: path.id
      - text: Remove the QoS profile with id {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'