Palo Alto Networks · OpenAPI Overlay 1.0.0

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

7 actions 7 updates phrasing extends openapi/palo-alto-networks-connectors-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['/v2/connectors'].get
$.paths['/v2/connectors'].post
$.paths['/v2/connectors/{connector_id}'].get
$.paths['/v2/connectors/{connector_id}'].put
$.paths['/v2/connectors/{connector_id}'].delete
$.paths['/v2/connectors/{connector_id}/upgrade'].post

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 Palo Alto Networks ZTNA Connector Connectors API
  version: 1.0.0
extends: openapi/palo-alto-networks-connectors-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['/v2/connectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List ZTNA connectors
      effect: read
      questions:
      - Which ZTNA connectors are deployed and are they healthy?
      - Can I list only the connectors in one connector group?
      instructions:
      - text: List all ZTNA connectors.
      - text: Show ZTNA connectors in group {group_id} with status {status}.
        slots:
          group_id: query.group_id
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/connectors'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a ZTNA connector and install token
      effect: write
      questions:
      - How do I get an installation token to deploy a new ZTNA connector?
      - Does a new connector need to belong to a connector group?
      instructions:
      - text: Create ZTNA connector {name} in group {group_id}.
        slots:
          name: requestBody.name
          group_id: requestBody.group_id
      - text: Set up a new connector {name} in group {group_id} described as {description}.
        slots:
          name: requestBody.name
          group_id: requestBody.group_id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/connectors/{connector_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a ZTNA connector's details
      effect: read
      questions:
      - What version and health status is a specific ZTNA connector running?
      - How do I look up one connector by ID?
      instructions:
      - text: Show ZTNA connector {connector_id}.
        slots:
          connector_id: path.connector_id
      - text: Get full details for connector {connector_id}.
        slots:
          connector_id: path.connector_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/connectors/{connector_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a ZTNA connector
      effect: write
      questions:
      - How do I rename an existing ZTNA connector?
      - Can I move a connector into a different connector group?
      instructions:
      - text: Rename connector {connector_id} to {name}, keeping it in group {group_id}.
        slots:
          connector_id: path.connector_id
          name: requestBody.name
          group_id: requestBody.group_id
      - text: Move connector {connector_id} named {name} into group {group_id}.
        slots:
          connector_id: path.connector_id
          name: requestBody.name
          group_id: requestBody.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/connectors/{connector_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a ZTNA connector
      effect: destructive
      questions:
      - How do I decommission a ZTNA connector?
      - Does a connector have to be disconnected before I can delete it?
      instructions:
      - text: Delete ZTNA connector {connector_id}.
        slots:
          connector_id: path.connector_id
      - text: Decommission the disconnected connector {connector_id}.
        slots:
          connector_id: path.connector_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/connectors/{connector_id}/upgrade'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a ZTNA connector software upgrade
      effect: write
      questions:
      - How do I upgrade a ZTNA connector's software during a maintenance window?
      - Will traffic fail over to other connectors while one is upgrading?
      instructions:
      - text: Upgrade connector {connector_id} now.
        slots:
          connector_id: path.connector_id
      - text: Schedule connector {connector_id} to upgrade to {target_version} at {scheduled_at}.
        slots:
          connector_id: path.connector_id
          target_version: requestBody.target_version
          scheduled_at: requestBody.scheduled_at
      method: generated
      generated: '2026-09-26'