Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SASE 5G Manage Service Control Plane Resource API

13 actions 13 updates phrasing extends openapi/palo-alto-networks-control-plane-resource-api-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 13

$.info
$.paths['/mt/manage/5g/control/cert/download'].get
$.paths['/mt/manage/5g/control/proxycert'].get
$.paths['/mt/manage/5g/control/proxycert/upload'].post
$.paths['/mt/manage/5g/control/radiusProxy'].get
$.paths['/mt/manage/5g/control/radiusProxy'].post
$.paths['/mt/manage/5g/control/radiusSecret'].get
$.paths['/mt/manage/5g/control/radiusSecret'].post
$.paths['/mt/manage/5g/control/radiusServers'].get
$.paths['/mt/manage/5g/control/supported/interfaces'].get
$.paths['/mt/manage/5g/control/interface'].get
$.paths['/mt/manage/5g/control/interface'].post
$.paths['/mt/manage/5g/control/interimMsg'].put

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 SASE 5G Manage Service Control Plane Resource API
  version: 1.0.0
extends: openapi/palo-alto-networks-control-plane-resource-api-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: 12
- target: $.paths['/mt/manage/5g/control/cert/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the 5G security certificate
      effect: read
      questions:
      - How do I download the certificate needed to activate 5G connectivity for a region?
      - Where do I get the security certificate file for my local 5G control plane?
      instructions:
      - text: Download the 5G control plane security certificate.
      - text: Export the regional 5G activation certificate for the local control plane.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mt/manage/5g/control/proxycert'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether a 5G proxy certificate exists
      effect: read
      questions:
      - Is a proxy certificate already present in my root TSG before 5G activation?
      - Can I verify the 5G proxy certificate status as a pre-activation check?
      instructions:
      - text: Verify whether the root TSG has a 5G proxy certificate.
      - text: Check the proxy certificate status for the 5G control plane.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mt/manage/5g/control/proxycert/upload'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a 5G proxy certificate
      effect: write
      questions:
      - How do I upload a proxy certificate to secure 5G control plane signaling?
      - Can I upload the proxy cert file for a specific TSG?
      instructions:
      - text: Upload proxy certificate file {file} for TSG {tsgId}.
        slots:
          file: requestBody.file
          tsgId: requestBody.tsgId
      - text: Inject proxy cert {filename} into root TSG {rootTsgId}.
        slots:
          filename: requestBody.filename
          rootTsgId: requestBody.rootTsgId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mt/manage/5g/control/radiusProxy'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the RADIUS proxy shared secret
      effect: read
      questions:
      - Where can I audit the RADIUS proxy shared secret configured on the root TSG?
      - What RADIUS proxy is my 5G control plane authenticating through?
      instructions:
      - text: Fetch the RADIUS proxy configuration for the root TSG.
      - text: Show the RADIUS proxy secret used by the 5G control plane.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mt/manage/5g/control/radiusProxy'].post
  update:
    x-apievangelist-phrasing:
      intent: Configure the RADIUS proxy server
      effect: write
      questions:
      - How do I point the 5G control plane at a RADIUS proxy by name and IP address?
      - Can I register a RADIUS proxy server for 5G authentication traffic?
      instructions:
      - text: Configure RADIUS proxy {name} at {ipaddress}.
        slots:
          name: requestBody.name
          ipaddress: requestBody.ipaddress
      - text: Set the 5G RADIUS proxy address to {ipaddress}.
        slots:
          ipaddress: requestBody.ipaddress
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mt/manage/5g/control/radiusSecret'].get
  update:
    x-apievangelist-phrasing:
      intent: View the RADIUS shared secret
      effect: read
      questions:
      - How can I see the active RADIUS shared secret to troubleshoot 5G auth failures?
      - Does the RADIUS secret on the root TSG match my on-prem server?
      instructions:
      - text: Show the active RADIUS shared secret for the root TSG.
      - text: Display the current RADIUS secret for troubleshooting.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mt/manage/5g/control/radiusSecret'].post
  update:
    x-apievangelist-phrasing:
      intent: Set or rotate the RADIUS shared secret
      effect: write
      questions:
      - How do I rotate the RADIUS shared secret for the root TSG?
      - Do RADIUS secret changes take effect immediately?
      instructions:
      - text: Set the RADIUS shared secret to {secret}.
        slots:
          secret: requestBody.secret
      - text: Rotate the RADIUS secret to {secret}, recorded as created by {created_by}.
        slots:
          secret: requestBody.secret
          created_by: requestBody.created_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mt/manage/5g/control/radiusServers'].get
  update:
    x-apievangelist-phrasing:
      intent: List RADIUS servers for 5G
      effect: read
      questions:
      - Which RADIUS servers are configured for 5G connectivity in my region?
      - Can I audit the active authentication nodes for regional redundancy?
      instructions:
      - text: List the RADIUS servers configured for 5G.
      - text: Show all regional RADIUS authentication servers.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mt/manage/5g/control/supported/interfaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List interfaces supported for 5G
      effect: read
      questions:
      - What interface types can the 5G control plane integrate with?
      - Which connection types are supported when planning a 5G deployment?
      instructions:
      - text: List the supported 5G control plane interfaces.
      - text: Show the interface types available for 5G integration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mt/manage/5g/control/interface'].get
  update:
    x-apievangelist-phrasing:
      intent: Show the interface assigned to 5G
      effect: read
      questions:
      - Which network interface is currently assigned to 5G operations?
      - Did my interface change for 5G signaling actually take effect?
      instructions:
      - text: Show the currently selected 5G interface.
      - text: Get the active interface configuration for 5G traffic.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mt/manage/5g/control/interface'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign the 5G control plane interface
      effect: write
      questions:
      - How do I choose the interface type, such as RADIUS, for 5G control plane traffic?
      - Can I enable interim messages with a reporting interval when assigning the interface?
      instructions:
      - text: Assign interface type {interfaceType} to the 5G control plane.
        slots:
          interfaceType: requestBody.interfaceType
      - text: Use {interfaceType} for 5G with interim messages every {interimMsgInterval}.
        slots:
          interfaceType: requestBody.interfaceType
          interimMsgInterval: requestBody.interimMsgInterval
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mt/manage/5g/control/interimMsg'].put
  update:
    x-apievangelist-phrasing:
      intent: Update interim message settings
      effect: write
      questions:
      - How do I change how often interim messages are reported for active 5G sessions?
      - Can I turn off interim message processing on the active interface?
      instructions:
      - text: Set the interim message interval to {interval}.
        slots:
          interval: requestBody.interval
      - text: Turn interim message processing {processMsg} with interval {interval}.
        slots:
          processMsg: requestBody.processMsg
          interval: requestBody.interval
      method: generated
      generated: '2026-09-26'