# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Palo Alto Networks Bandwidth Allocations API
  version: 1.0.0
extends: openapi/palo-alto-networks-bandwidth-allocations-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: 18
- target: $.paths['/v1/bandwidth-allocations'].get
  update:
    x-apievangelist-phrasing:
      intent: Check status of a v1 bandwidth allocation request
      effect: read
      questions:
      - How do I check whether my v1 aggregated bandwidth allocation request finished?
      - What regions and allocations came back for a v1 bandwidth request ID?
      instructions:
      - text: Get the v1 aggregated bandwidth allocation status for request {id}.
        slots:
          id: query.id
      - text: Check whether v1 bandwidth request {id} has completed.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/bandwidth-allocations'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit aggregated bandwidth regions (v1)
      effect: write
      questions:
      - Can I change existing aggregated bandwidth allocations with the v1 endpoint?
      - How do I modify region bandwidth for a sub-tenant using the older v1 API?
      instructions:
      - text: Modify v1 aggregated bandwidth allocations to {bandwidth_allocations}.
        slots:
          bandwidth_allocations: requestBody.bandwidth_allocations
      - text: Edit v1 bandwidth regions for sub-tenant {SubTenantName} with allocations {bandwidth_allocations}.
        slots:
          SubTenantName: query.SubTenantName
          bandwidth_allocations: requestBody.bandwidth_allocations
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/bandwidth-allocations'].post
  update:
    x-apievangelist-phrasing:
      intent: Allocate aggregated bandwidth to regions (v1)
      effect: write
      questions:
      - How do I allocate aggregated bandwidth across Prisma Access regions with the v1 API?
      - Is bandwidth allocated from location data when I submit a v1 request?
      instructions:
      - text: Allocate aggregated bandwidth via v1 as {bandwidth_allocations}.
        slots:
          bandwidth_allocations: requestBody.bandwidth_allocations
      - text: Submit a v1 bandwidth allocation for sub-tenant {SubTenantName}.
        slots:
          SubTenantName: query.SubTenantName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/bandwidth-allocations'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an aggregated bandwidth region (v1)
      effect: destructive
      questions:
      - Can I remove a bandwidth region through the v1 endpoint?
      - Which region and SPN name do I need to delete a v1 bandwidth region?
      instructions:
      - text: Delete v1 bandwidth region {region} with SPN {SpnName}.
        slots:
          region: query.region
          SpnName: query.SpnName
      - text: Remove region {region} (SPN {SpnName}) from sub-tenant {SubTenantName} using the v1 endpoint.
        slots:
          region: query.region
          SpnName: query.SpnName
          SubTenantName: query.SubTenantName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/bandwidth-allocations-read'].get
  update:
    x-apievangelist-phrasing:
      intent: Get bandwidth allocation configurations for a read request
      effect: read
      questions:
      - Where do I fetch the results of a bandwidth allocation read request?
      - What bandwidth configurations came back for the regions I asked about?
      instructions:
      - text: Get the bandwidth allocation configurations for read request {id}.
        slots:
          id: query.id
      - text: Fetch the results of bandwidth config read {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/bandwidth-allocations-read'].post
  update:
    x-apievangelist-phrasing:
      intent: Request bandwidth allocation config for regions
      effect: read
      questions:
      - How do I ask for the bandwidth allocation configuration of specific regions?
      - Can I read allocations for just a few named regions?
      instructions:
      - text: Request the bandwidth allocation configuration for regions {bandwidth_allocation_region_names}.
        slots:
          bandwidth_allocation_region_names: requestBody.bandwidth_allocation_region_names
      - text: Start a bandwidth config read for sub-tenant {SubTenantName}.
        slots:
          SubTenantName: query.SubTenantName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/bandwidth-allocations'].get
  update:
    x-apievangelist-phrasing:
      intent: Get aggregated bandwidth regions (v2)
      effect: read
      questions:
      - Which aggregated bandwidth regions does the v2 API return for my request?
      - Can I look up v2 bandwidth regions by request ID?
      instructions:
      - text: Get the v2 aggregated bandwidth regions for request {id}.
        slots:
          id: query.id
      - text: Look up v2 bandwidth regions returned for request {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/bandwidth-allocations'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit aggregated bandwidth regions (v2)
      effect: write
      questions:
      - How do I modify aggregated bandwidth regions with the v2 API?
      - Can I change a sub-tenant's region bandwidth through v2?
      instructions:
      - text: Modify v2 aggregated bandwidth regions with allocations {bandwidth_allocations}.
        slots:
          bandwidth_allocations: requestBody.bandwidth_allocations
      - text: Edit v2 bandwidth regions for sub-tenant {SubTenantName}.
        slots:
          SubTenantName: query.SubTenantName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/bandwidth-allocations'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a v2 bandwidth allocation request
      effect: write
      questions:
      - What does posting to the v2 bandwidth allocations endpoint return?
      - Can I get a request ID status back when I submit v2 allocations?
      instructions:
      - text: Submit v2 bandwidth allocations {bandwidth_allocations} and return the request status.
        slots:
          bandwidth_allocations: requestBody.bandwidth_allocations
      - text: Post a v2 bandwidth request for sub-tenant {SubTenantName} with UUID {uuid}.
        slots:
          SubTenantName: query.SubTenantName
          uuid: requestBody.uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/bandwidth-allocations'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an aggregated bandwidth region (v2)
      effect: destructive
      questions:
      - How do I delete an aggregated bandwidth region with the v2 API?
      - Can I remove a v2 bandwidth region for one sub-tenant only?
      instructions:
      - text: Delete v2 aggregated bandwidth region {region} for SPN {SpnName}.
        slots:
          region: query.region
          SpnName: query.SpnName
      - text: Remove v2 region {region} with SPN {SpnName} from sub-tenant {SubTenantName}.
        slots:
          region: query.region
          SpnName: query.SpnName
          SubTenantName: query.SubTenantName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bandwidth-allocations'].get
  update:
    x-apievangelist-phrasing:
      intent: List bandwidth allocations
      effect: read
      questions:
      - Which remote network bandwidth allocations do I have configured?
      - Can I page through my bandwidth regions?
      instructions:
      - text: List my bandwidth allocations.
      - text: Show {limit} bandwidth regions starting at {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bandwidth-allocations'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a named bandwidth allocation
      effect: write
      questions:
      - How do I raise the allocated bandwidth on an existing region?
      - Can I change the QoS settings of a bandwidth allocation I already have?
      instructions:
      - text: Update bandwidth allocation {name} to {allocated_bandwidth} Mbps.
        slots:
          name: requestBody.name
          allocated_bandwidth: requestBody.allocated_bandwidth
      - text: Set the QoS on bandwidth allocation {name} with {allocated_bandwidth} to {qos}.
        slots:
          name: requestBody.name
          allocated_bandwidth: requestBody.allocated_bandwidth
          qos: requestBody.qos
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bandwidth-allocations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a bandwidth allocation
      effect: write
      questions:
      - What's needed to create a new bandwidth allocation for a region?
      - Can I assign SPNs when I create a bandwidth allocation?
      instructions:
      - text: Create a bandwidth allocation for region {name} with {allocated_bandwidth} Mbps.
        slots:
          name: requestBody.name
          allocated_bandwidth: requestBody.allocated_bandwidth
      - text: Add a new allocation {name} of {allocated_bandwidth} across SPNs {spn_name_list}.
        slots:
          name: requestBody.name
          allocated_bandwidth: requestBody.allocated_bandwidth
          spn_name_list: requestBody.spn_name_list
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bandwidth-allocations'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a bandwidth allocation
      effect: destructive
      questions:
      - How do I remove a bandwidth allocation along with its SPN list?
      - Which fields identify a bandwidth allocation I want to delete?
      instructions:
      - text: Delete bandwidth allocation {name} for SPNs {spn_name_list}.
        slots:
          name: query.name
          spn_name_list: query.spn_name_list
      - text: Remove the {name} bandwidth allocation spanning {spn_name_list}.
        slots:
          name: query.name
          spn_name_list: query.spn_name_list
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/bandwidth-allocations'].get
  update:
    x-apievangelist-phrasing:
      intent: List aggregated bandwidth regions
      effect: read
      questions:
      - How is bandwidth allocated across my aggregated regions?
      - Which aggregated bandwidth regions are configured for remote networks?
      instructions:
      - text: List all aggregated bandwidth regions.
      - text: Show {limit} bandwidth allocation regions.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/bandwidth-allocations'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit an aggregated bandwidth region
      effect: write
      questions:
      - Can I raise the Mbps allocated to an existing bandwidth region?
      - Is it possible to change the QoS settings on a bandwidth region?
      instructions:
      - text: Set bandwidth region {name} to {allocated_bandwidth} Mbps.
        slots:
          name: requestBody.name
          allocated_bandwidth: requestBody.allocated_bandwidth
      - text: Edit region {name} to {allocated_bandwidth} Mbps across SPNs {spn_name_list}.
        slots:
          name: requestBody.name
          allocated_bandwidth: requestBody.allocated_bandwidth
          spn_name_list: requestBody.spn_name_list
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/bandwidth-allocations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an aggregated bandwidth region
      effect: write
      questions:
      - How do I allocate bandwidth to a new region?
      - What do I need to create an aggregated bandwidth region with QoS?
      instructions:
      - text: Create bandwidth region {name} with {allocated_bandwidth} Mbps.
        slots:
          name: requestBody.name
          allocated_bandwidth: requestBody.allocated_bandwidth
      - text: Add aggregated region {name} at {allocated_bandwidth} Mbps with QoS {qos}.
        slots:
          name: requestBody.name
          allocated_bandwidth: requestBody.allocated_bandwidth
          qos: requestBody.qos
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/bandwidth-allocations'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an aggregated bandwidth region
      effect: destructive
      questions:
      - How do I remove an aggregated bandwidth region?
      - Which SPN names do I need to pass to delete a bandwidth region?
      instructions:
      - text: Delete bandwidth region {name} with SPNs {spn_name_list}.
        slots:
          name: query.name
          spn_name_list: query.spn_name_list
      - text: Remove aggregated region {name}; SPN list {spn_name_list}.
        slots:
          name: query.name
          spn_name_list: query.spn_name_list
      method: generated
      generated: '2026-10-01'