Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SP Interconnect Manage Physical Connection API

5 actions 5 updates phrasing extends openapi/palo-alto-networks-physical-connection-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/physical-connections'].get

$.paths['/mt/sp-interconnect/interconnects/physical-connections'].post

$.paths['/mt/sp-interconnect/interconnects/physical-connections/{physicalConnectionId}'].get

$.paths['/mt/sp-interconnect/interconnects/physical-connections/{physicalConnectionId}'].delete

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 SP Interconnect Manage Physical Connection API
  version: 1.0.0
extends: openapi/palo-alto-networks-physical-connection-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/physical-connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List interconnect physical connections
      effect: read
      questions:
      - What physical links back my service provider interconnects, and what speeds do they run at?
      - Can I see MACsec encryption status across all my interconnect hardware links?
      instructions:
      - text: List all physical connections on my interconnects.
      - text: Show link speed and MACsec status for every interconnect physical link.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mt/sp-interconnect/interconnects/physical-connections'].post
  update:
    x-apievangelist-phrasing:
      intent: Provision an interconnect physical connection
      effect: write
      questions:
      - How do I request a new physical link at a colocation facility before setting up virtual circuits?
      - Can I turn on MACsec and ask for several links when provisioning a physical connection?
      instructions:
      - text: Provision physical connection {physicalConnectionName} ({linkType}) at {coloFacilities} with partner {partnerName}, contact {partnerEmail}.
        slots:
          physicalConnectionName: requestBody.physicalConnectionName
          linkType: requestBody.linkType
          coloFacilities: requestBody.coloFacilities
          partnerName: requestBody.partnerName
          partnerEmail: requestBody.partnerEmail
      - text: Request {requestedLinkCount} {linkType} links named {physicalConnectionName} at {coloFacilities} via {partnerName} ({partnerEmail}), MACsec {macSecEnabled}.
        slots:
          requestedLinkCount: requestBody.requestedLinkCount
          linkType: requestBody.linkType
          physicalConnectionName: requestBody.physicalConnectionName
          coloFacilities: requestBody.coloFacilities
          partnerName: requestBody.partnerName
          partnerEmail: requestBody.partnerEmail
          macSecEnabled: requestBody.macSecEnabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mt/sp-interconnect/interconnects/physical-connections/{physicalConnectionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one interconnect physical connection
      effect: read
      questions:
      - What colocation address and HA status does a specific physical link have?
      - Can I get the full technical spec of one physical connection before an on-site visit?
      instructions:
      - text: Get physical connection {physicalConnectionId}.
        slots:
          physicalConnectionId: path.physicalConnectionId
      - text: Show detailed specs for physical link {physicalConnectionId} with includeDetails={includeDetails}.
        slots:
          physicalConnectionId: path.physicalConnectionId
          includeDetails: query.includeDetails
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mt/sp-interconnect/interconnects/physical-connections/{physicalConnectionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Decommission an interconnect physical connection
      effect: destructive
      questions:
      - How do I decommission a physical interconnect link we no longer use?
      - Can I delete one physical connection by its ID to release the hardware?
      instructions:
      - text: Decommission physical connection {physicalConnectionId}.
        slots:
          physicalConnectionId: path.physicalConnectionId
      - text: Delete the interconnect physical link {physicalConnectionId}.
        slots:
          physicalConnectionId: path.physicalConnectionId
      method: generated
      generated: '2026-09-26'