Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Network Deployment Service Connection Groups API

11 actions 11 updates phrasing extends openapi/palo-alto-networks-service-connection-groups-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 11

$.info
$.paths['/service-connection-groups'].get
$.paths['/service-connection-groups'].post
$.paths['/service-connection-groups/{id}'].get
$.paths['/service-connection-groups/{id}'].put
$.paths['/service-connection-groups/{id}'].delete
$.paths['/sse/config/v1/service-connection-groups'].get
$.paths['/sse/config/v1/service-connection-groups'].post
$.paths['/sse/config/v1/service-connection-groups/{id}'].get
$.paths['/sse/config/v1/service-connection-groups/{id}'].put
$.paths['/sse/config/v1/service-connection-groups/{id}'].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 Network Deployment Service Connection Groups API
  version: 1.0.0
extends: openapi/palo-alto-networks-service-connection-groups-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/service-connection-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List service connection groups
      effect: read
      questions:
      - Which service connection groups are configured in my folder?
      - Can I look up a service connection group by name?
      instructions:
      - text: List the service connection groups in folder {folder}.
        slots:
          folder: query.folder
      - text: Find service connection group {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/service-connection-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a service connection group
      effect: write
      questions:
      - How do I group service connections together under one target?
      - Can I disable source NAT on a new service connection group?
      instructions:
      - text: Create service connection group {name} (ID {id}) targeting {target}.
        slots:
          name: requestBody.name
          id: requestBody.id
          target: requestBody.target
      - text: Create service connection group {name} (ID {id}) for {target} with SNAT disabled {disable_snat}.
        slots:
          name: requestBody.name
          id: requestBody.id
          target: requestBody.target
          disable_snat: requestBody.disable_snat
      method: generated
      generated: '2026-09-26'
- target: $.paths['/service-connection-groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a service connection group
      effect: read
      questions:
      - What targets belong to a specific service connection group?
      - Can I fetch a service connection group by its ID?
      instructions:
      - text: Get service connection group {id}.
        slots:
          id: path.id
      - text: Show the targets and SNAT setting of service connection group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/service-connection-groups/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a service connection group
      effect: write
      questions:
      - Can I change which service connections an existing group targets?
      - Is it possible to switch an existing service connection group to policy-based forwarding only?
      instructions:
      - text: Update service connection group {id} ({name}, body ID {body_id}) to target {target}.
        slots:
          id: path.id
          name: requestBody.name
          body_id: requestBody.id
          target: requestBody.target
      - text: Set PBF-only to {pbf_only} on group {id} ({name}, ID {body_id}, target {target}).
        slots:
          pbf_only: requestBody.pbf_only
          id: path.id
          name: requestBody.name
          body_id: requestBody.id
          target: requestBody.target
      method: generated
      generated: '2026-09-26'
- target: $.paths['/service-connection-groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a service connection group
      effect: destructive
      questions:
      - How do I remove a service connection group?
      - Can I delete a service connection group by ID?
      instructions:
      - text: Delete service connection group {id}.
        slots:
          id: path.id
      - text: Remove service connection group {id} from Prisma Access.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/service-connection-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List service connection groups
      effect: read
      questions:
      - Which service connection groups are configured in a folder?
      - Can I find a service connection group by name?
      instructions:
      - text: List service connection groups in folder {folder} through the SSE config v1 path.
        slots:
          folder: query.folder
      - text: Find service connection group {name} in folder {folder} via the SSE config v1 endpoint.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/service-connection-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a service connection group
      effect: write
      questions:
      - How do I group several service connections together?
      - Can I disable source NAT or restrict a service connection group to PBF only?
      instructions:
      - text: Create service connection group {name} in folder {folder} with connections {target}.
        slots:
          name: requestBody.name
          folder: query.folder
          target: requestBody.target
      - text: Create group {name} in {folder} for service connections {target} with disable_snat {disable_snat}.
        slots:
          name: requestBody.name
          folder: query.folder
          target: requestBody.target
          disable_snat: requestBody.disable_snat
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/service-connection-groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a service connection group
      effect: read
      questions:
      - Which service connections are in a specific service connection group?
      - Can I fetch one service connection group by ID?
      instructions:
      - text: Get service connection group {id} from the SSE config v1 path.
        slots:
          id: path.id
      - text: Show the member connections of service connection group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/service-connection-groups/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a service connection group
      effect: write
      questions:
      - Can I add or remove service connections from an existing group?
      - Is there a way to turn on PBF-only for a service connection group?
      instructions:
      - text: Set the connections of service connection group {id} ({name}) to {target}.
        slots:
          id: path.id
          name: requestBody.name
          target: requestBody.target
      - text: Update group {id} ({name}, connections {target}) with pbf_only {pbf_only}.
        slots:
          id: path.id
          name: requestBody.name
          target: requestBody.target
          pbf_only: requestBody.pbf_only
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/service-connection-groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a service connection group
      effect: destructive
      questions:
      - How do I delete a service connection group?
      - Can I remove a service connection group by ID?
      instructions:
      - text: Delete service connection group {id} using the SSE config v1 endpoint.
        slots:
          id: path.id
      - text: Remove the service connection group with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'