Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SP Interconnect Manage IP Pool API

5 actions 5 updates phrasing extends openapi/palo-alto-networks-ip-pool-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['/mt/sp-interconnect/interconnects/{interconnectId}/ip-pool'].get
$.paths['/mt/sp-interconnect/interconnects/{interconnectId}/ip-pool'].put
$.paths['/mt/sp-interconnect/interconnects/{interconnectId}/ip-pool'].post
$.paths['/mt/sp-interconnect/interconnects/{interconnectId}/ip-pool'].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 SP Interconnect Manage IP Pool API
  version: 1.0.0
extends: openapi/palo-alto-networks-ip-pool-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['/mt/sp-interconnect/interconnects/{interconnectId}/ip-pool'].get
  update:
    x-apievangelist-phrasing:
      intent: View an interconnect's IP address pool
      effect: read
      questions:
      - Which CIDR ranges are assigned to my service provider interconnect?
      - Is an interconnect's IP pool provided by the SP or by Palo Alto Networks?
      instructions:
      - text: Show the IP address pool for interconnect {interconnectId}.
        slots:
          interconnectId: path.interconnectId
      - text: Get the CIDR blocks and provider status on interconnect {interconnectId}.
        slots:
          interconnectId: path.interconnectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mt/sp-interconnect/interconnects/{interconnectId}/ip-pool'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an interconnect's IP address pool
      effect: write
      questions:
      - Can I change the IP blocks on an interconnect pool that already exists?
      - How do I switch an existing pool's IP provider?
      instructions:
      - text: Update the IP pool on interconnect {interconnectId} to provider {ipProvider} with blocks {ipBlocks}.
        slots:
          interconnectId: path.interconnectId
          ipProvider: requestBody.ipProvider
          ipBlocks: requestBody.ipBlocks
      - text: Change the existing pool's IP provider on interconnect {interconnectId} to {ipProvider}.
        slots:
          interconnectId: path.interconnectId
          ipProvider: requestBody.ipProvider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mt/sp-interconnect/interconnects/{interconnectId}/ip-pool'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a new IP address pool to an interconnect
      effect: write
      questions:
      - How do I provision the first IP address pool on a new interconnect?
      - Can a newly attached pool use SP-provided addresses instead of PANW-provided ones?
      instructions:
      - text: Create a new IP pool on interconnect {interconnectId} with provider {ipProvider}.
        slots:
          interconnectId: path.interconnectId
          ipProvider: requestBody.ipProvider
      - text: Provision pool blocks {ipBlocks} from provider {ipProvider} on interconnect {interconnectId}.
        slots:
          ipBlocks: requestBody.ipBlocks
          ipProvider: requestBody.ipProvider
          interconnectId: path.interconnectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mt/sp-interconnect/interconnects/{interconnectId}/ip-pool'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an interconnect's IP address pool
      effect: destructive
      questions:
      - What happens to routing when I delete an interconnect's IP pool?
      - Can I unassign all CIDR blocks from an interconnect at once?
      instructions:
      - text: Delete the IP pool on interconnect {interconnectId}.
        slots:
          interconnectId: path.interconnectId
      - text: Remove all IP block associations from interconnect {interconnectId}.
        slots:
          interconnectId: path.interconnectId
      method: generated
      generated: '2026-09-26'