Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Instances Instance API

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

$.info
$.paths['/subscription/v1/instances'].get
$.paths['/subscription/v1/instances'].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 Instances Instance API
  version: 1.0.0
extends: openapi/palo-alto-networks-instance-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: 2
- target: $.paths['/subscription/v1/instances'].get
  update:
    x-apievangelist-phrasing:
      intent: List licensed tenant instances
      effect: read
      questions:
      - Which instances have licenses allocated in my tenant service group?
      - Can I also see instances that belong to child tenants?
      instructions:
      - text: List all instances in my TSG.
      - text: List instances including child tenants, with_children set to {with_children}.
        slots:
          with_children: query.with_children
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscription/v1/instances'].post
  update:
    x-apievangelist-phrasing:
      intent: Allocate a license to a child tenant
      effect: write
      questions:
      - How do I allocate a license to a child tenant as a new instance?
      - Do I need to claim a license before creating an instance, and is provisioning immediate?
      instructions:
      - text: Create a new instance under my TSG to allocate a license to a child tenant.
      - text: Start provisioning a licensed instance for the child tenant.
      method: generated
      generated: '2026-09-26'