Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks AIOps for NGFW BPA 5G Deregistered Trend…

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

$.info

$.paths['/subscriptions'].get

$.paths['/subscriptions/{subscription_id}'].get

$.paths['/subscriptions/{subscription_id}/entitlements'].get

$.paths['/subscriptions/{subscription_id}/allocation'].put

OpenAPI Overlay

# 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 AIOps for NGFW BPA 5G Deregistered Trend…
  version: 1.0.0
extends: openapi/palo-alto-networks-subscriptions-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: 4
- target: $.paths['/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscriptions for a tenant service group
      effect: read
      questions:
      - What active subscriptions and SKUs does my tenant service group have?
      - Can I filter subscriptions by product or status?
      instructions:
      - text: List subscriptions for TSG {tsg_id}.
        slots:
          tsg_id: query.tsg_id
      - text: Show {status} subscriptions for product {product} in TSG {tsg_id}.
        slots:
          status: query.status
          product: query.product
          tsg_id: query.tsg_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscription_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get subscription details
      effect: read
      questions:
      - When does a particular subscription term end and how much of it is used?
      - What licensed capacity does one subscription include?
      instructions:
      - text: Get subscription {subscription_id}.
        slots:
          subscription_id: path.subscription_id
      - text: Show term dates and utilization for subscription {subscription_id}.
        slots:
          subscription_id: path.subscription_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscription_id}/entitlements'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscription's entitlements
      effect: read
      questions:
      - Which individual features are entitled under a subscription and how many remain available?
      - How is a subscription's entitlement allocated per child TSG?
      instructions:
      - text: Get the entitlement breakdown for subscription {subscription_id}.
        slots:
          subscription_id: path.subscription_id
      - text: Show per-feature allocated and available quantities for {subscription_id}.
        slots:
          subscription_id: path.subscription_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscription_id}/allocation'].put
  update:
    x-apievangelist-phrasing:
      intent: Allocate subscription licenses to child TSGs
      effect: write
      questions:
      - How do I split license capacity from one subscription across child tenants?
      - Can I allocate more licenses to child TSGs than the subscription holds?
      instructions:
      - text: Allocate licenses from subscription {subscription_id} as {allocations}.
        slots:
          subscription_id: path.subscription_id
          allocations: requestBody.allocations
      - text: Reallocate capacity of {subscription_id} to child TSGs per {allocations}.
        slots:
          subscription_id: path.subscription_id
          allocations: requestBody.allocations
      method: generated
      generated: '2026-09-26'