Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks ZTNA Connector Connector Groups API

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

$.info

$.paths['/v2/connector-groups'].get

$.paths['/v2/connector-groups'].post

$.paths['/v2/connector-groups/{group_id}'].get

$.paths['/v2/connector-groups/{group_id}'].put

$.paths['/v2/connector-groups/{group_id}'].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 Palo Alto Networks ZTNA Connector Connector Groups API
  version: 1.0.0
extends: openapi/palo-alto-networks-connector-groups-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: 5
- target: $.paths['/v2/connector-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List ZTNA connector groups
      effect: read
      questions:
      - What connector groups do I have for load balancing ZTNA connectors?
      - Which groups are my private applications assigned to?
      instructions:
      - text: List all connector groups.
      - text: Show my ZTNA connector groups used for high availability.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/connector-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a ZTNA connector group
      effect: write
      questions:
      - How do I create a new group to organize ZTNA connectors?
      - Can I pin a connector group to a region when creating it?
      instructions:
      - text: Create connector group {name}.
        slots:
          name: requestBody.name
      - text: Create connector group {name} in region {region}.
        slots:
          name: requestBody.name
          region: requestBody.region
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/connector-groups/{group_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a connector group's details
      effect: read
      questions:
      - What are the full details of a specific connector group?
      - How do I look up a connector group by its ID?
      instructions:
      - text: Show connector group {group_id}.
        slots:
          group_id: path.group_id
      - text: Get details for ZTNA connector group {group_id}.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/connector-groups/{group_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a connector group
      effect: write
      questions:
      - How do I rename an existing connector group?
      - Can I change a connector group's region or description?
      instructions:
      - text: Rename connector group {group_id} to {name}.
        slots:
          group_id: path.group_id
          name: requestBody.name
      - text: Update connector group {group_id} named {name} to region {region}.
        slots:
          group_id: path.group_id
          name: requestBody.name
          region: requestBody.region
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/connector-groups/{group_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an empty connector group
      effect: destructive
      questions:
      - How do I delete a connector group?
      - Must a connector group be empty before it can be removed?
      instructions:
      - text: Delete connector group {group_id}.
        slots:
          group_id: path.group_id
      - text: Remove the empty ZTNA connector group {group_id}.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'