Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SP Interconnect Manage Vlan Attachment API

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

$.info
$.paths['/mt/sp-interconnect/interconnects/{interconnectId}/vlan-attachments'].get
$.paths['/mt/sp-interconnect/interconnects/{interconnectId}/vlan-attachments'].post
$.paths['/mt/sp-interconnect/interconnects/{interconnectId}/vlan-attachments/{vlanAttachmentId}'].get
$.paths['/mt/sp-interconnect/interconnects/{interconnectId}/vlan-attachments/{vlanAttachmentId}'].delete
$.paths['/mt/sp-interconnect/interconnects/{interconnectId}/vlan-attachments/{vlanAttachmentId}/accept'].post
$.paths['/mt/sp-interconnect/interconnects/{interconnectId}/vlan-attachments/{vlanAttachmentId}/logs'].get

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 Vlan Attachment API
  version: 1.0.0
extends: openapi/palo-alto-networks-vlan-attachment-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: 6
- target: $.paths['/mt/sp-interconnect/interconnects/{interconnectId}/vlan-attachments'].get
  update:
    x-apievangelist-phrasing:
      intent: List VLAN attachments on an interconnect
      effect: read
      questions:
      - Which virtual circuits are configured on my service provider interconnect?
      - Can I check the BGP state of every VLAN attachment in an interconnect?
      instructions:
      - text: List VLAN attachments on interconnect {interconnectId}.
        slots:
          interconnectId: path.interconnectId
      - text: Show all virtual circuits and their BGP states for interconnect {interconnectId}.
        slots:
          interconnectId: path.interconnectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mt/sp-interconnect/interconnects/{interconnectId}/vlan-attachments'].post
  update:
    x-apievangelist-phrasing:
      intent: Provision a VLAN attachment
      effect: write
      questions:
      - How do I create a new virtual circuit for Prisma Access traffic on an interconnect?
      - What BGP and BFD settings are required for a new VLAN attachment?
      instructions:
      - text: Provision VLAN attachment {name} on interconnect {interconnectId} with peer ASN {bgpPeerAsn} and BFD mode {bfdMode}.
        slots:
          name: requestBody.name
          interconnectId: path.interconnectId
          bgpPeerAsn: requestBody.bgpPeerAsn
          bfdMode: requestBody.bgpPeerBfdSessionInitMode
      - text: Create a {bandwidth} circuit {name} on {interconnectId}, BGP ASN {bgpPeerAsn}, BFD init {bfdMode}.
        slots:
          bandwidth: requestBody.bandwidth
          name: requestBody.name
          interconnectId: path.interconnectId
          bgpPeerAsn: requestBody.bgpPeerAsn
          bfdMode: requestBody.bgpPeerBfdSessionInitMode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mt/sp-interconnect/interconnects/{interconnectId}/vlan-attachments/{vlanAttachmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a VLAN attachment
      effect: read
      questions:
      - What BGP timers and MD5 settings does one virtual circuit use?
      - Can I see whether a VLAN attachment is IPv4 or dual-stack?
      instructions:
      - text: Show VLAN attachment {vlanAttachmentId} on interconnect {interconnectId}.
        slots:
          vlanAttachmentId: path.vlanAttachmentId
          interconnectId: path.interconnectId
      - text: Get the full spec of circuit {vlanAttachmentId} in {interconnectId}.
        slots:
          vlanAttachmentId: path.vlanAttachmentId
          interconnectId: path.interconnectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mt/sp-interconnect/interconnects/{interconnectId}/vlan-attachments/{vlanAttachmentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a VLAN attachment
      effect: destructive
      questions:
      - How do I retire a virtual circuit on an interconnect?
      - Is deleting a VLAN attachment permanent?
      instructions:
      - text: Delete VLAN attachment {vlanAttachmentId} from interconnect {interconnectId}.
        slots:
          vlanAttachmentId: path.vlanAttachmentId
          interconnectId: path.interconnectId
      - text: Tear down circuit {vlanAttachmentId} on {interconnectId}.
        slots:
          vlanAttachmentId: path.vlanAttachmentId
          interconnectId: path.interconnectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mt/sp-interconnect/interconnects/{interconnectId}/vlan-attachments/{vlanAttachmentId}/accept'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept a pending AWS attachment
      effect: write
      questions:
      - My AWS Direct Connect attachment is pending acceptance; how do I confirm it?
      - What activates a virtual circuit that AWS is waiting on?
      instructions:
      - text: Accept AWS attachment {vlanAttachmentId} on interconnect {interconnectId}.
        slots:
          vlanAttachmentId: path.vlanAttachmentId
          interconnectId: path.interconnectId
      - text: Confirm the pending Direct Connect circuit {vlanAttachmentId} in {interconnectId}.
        slots:
          vlanAttachmentId: path.vlanAttachmentId
          interconnectId: path.interconnectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mt/sp-interconnect/interconnects/{interconnectId}/vlan-attachments/{vlanAttachmentId}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Cloud Router logs for an attachment
      effect: read
      questions:
      - Can I pull GCP Cloud Router logs for a VLAN attachment?
      - How far back can I fetch router logs for a virtual circuit?
      instructions:
      - text: Get Cloud Router logs for attachment {vlanAttachmentId} on {interconnectId}.
        slots:
          vlanAttachmentId: path.vlanAttachmentId
          interconnectId: path.interconnectId
      - text: Show the last {duration} of router logs for circuit {vlanAttachmentId} in {interconnectId}.
        slots:
          duration: query.duration
          vlanAttachmentId: path.vlanAttachmentId
          interconnectId: path.interconnectId
      method: generated
      generated: '2026-09-26'