API Evangelist conversational phrasing for ZTNA Restful Connector API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ZTNA Restful Connector API
  version: 1.0.0
extends: openapi/palo-alto-networks-connector-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: 22
- target: $.paths['/sse/connector/v2.0/api/connectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List ZTNA connectors
      effect: read
      questions:
      - Which ZTNA connectors are deployed in my Prisma Access tenant?
      - Can I search or filter the connector list by a specific field and sort the results?
      instructions:
      - text: List all my ZTNA connectors.
      - text: Show ZTNA connectors matching {search}, sorted by {sort}.
        slots:
          search: query.search
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connectors'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a ZTNA connector
      effect: write
      questions:
      - How do I register a new ZTNA connector and put it in a connector group?
      - What do I need to supply when adding another ZTNA connector?
      instructions:
      - text: Create a ZTNA connector named {name} in connector group {group}.
        slots:
          name: requestBody.name
          group: requestBody.group
      - text: Add a new ZTNA connector {name} to group {group} with description {description}.
        slots:
          name: requestBody.name
          group: requestBody.group
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connectors/{oid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a ZTNA connector's details
      effect: read
      questions:
      - What is the current configuration of one specific ZTNA connector?
      - Can I look up a single connector by its object ID?
      instructions:
      - text: Show me the details of ZTNA connector {oid}.
        slots:
          oid: path.oid
      - text: Fetch connector {oid} and tell me which group it belongs to.
        slots:
          oid: path.oid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connectors/{oid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a ZTNA connector
      effect: write
      questions:
      - How do I rename a ZTNA connector or move it to a different connector group?
      - Can I change the description on an existing connector?
      instructions:
      - text: Rename ZTNA connector {oid} to {name} and keep it in group {group}.
        slots:
          oid: path.oid
          name: requestBody.name
          group: requestBody.group
      - text: Move connector {oid} named {name} into connector group {group}.
        slots:
          oid: path.oid
          name: requestBody.name
          group: requestBody.group
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connectors/{oid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a ZTNA connector
      effect: destructive
      questions:
      - How do I remove a ZTNA connector I no longer use?
      - What happens to a connector once I delete it from Prisma Access?
      instructions:
      - text: Delete ZTNA connector {oid}.
        slots:
          oid: path.oid
      - text: Remove the decommissioned connector {oid} from my tenant.
        slots:
          oid: path.oid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connectors/filters'].get
  update:
    x-apievangelist-phrasing:
      intent: Get filter values for connector fields
      effect: read
      questions:
      - What values can I filter ZTNA connectors by for a given field?
      - Which distinct values exist for a connector field before I build a filter?
      instructions:
      - text: Show the available filter values for the connector field {field}.
        slots:
          field: query.field
      - text: List filter options for connector field {field} that match {search}.
        slots:
          field: query.field
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connectors/{oid}/quiesce'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a connector's quiesce state
      effect: read
      questions:
      - Is a particular ZTNA connector currently quiesced?
      - How can I see whether a connector is draining traffic before maintenance?
      instructions:
      - text: Check the quiesce state of connector {oid}.
        slots:
          oid: path.oid
      - text: Tell me whether connector {oid} is quiesced right now.
        slots:
          oid: path.oid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connectors/{oid}/quiesce'].put
  update:
    x-apievangelist-phrasing:
      intent: Quiesce or resume a ZTNA connector
      effect: write
      questions:
      - How do I put a ZTNA connector into quiesce mode before taking it down?
      - Can I take a connector out of quiesce mode once maintenance is done?
      instructions:
      - text: Set the quiesce mode of connector {oid} to {mode}.
        slots:
          oid: path.oid
          mode: requestBody.mode
      - text: Quiesce connector {oid} by switching its mode to {mode}.
        slots:
          oid: path.oid
          mode: requestBody.mode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connectors/{oid}/scheduled-upgrade'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a connector's scheduled upgrade
      effect: read
      questions:
      - Is there a software upgrade scheduled for this ZTNA connector?
      - Which image and time is a connector's upgrade set for?
      instructions:
      - text: Show the scheduled upgrade for connector {oid}.
        slots:
          oid: path.oid
      - text: Tell me which image and time connector {oid} is set to upgrade at.
        slots:
          oid: path.oid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connectors/{oid}/scheduled-upgrade'].put
  update:
    x-apievangelist-phrasing:
      intent: Reschedule a connector upgrade
      effect: write
      questions:
      - How do I change the time of an upgrade already scheduled on a connector?
      - Can I switch an existing scheduled upgrade to a different connector image?
      instructions:
      - text: Change connector {oid}'s existing scheduled upgrade to image {image_id} at {scheduled_upgrade}.
        slots:
          oid: path.oid
          image_id: requestBody.image_id
          scheduled_upgrade: requestBody.scheduled_upgrade
      - text: Update the already scheduled download on connector {oid} to {scheduled_download} for image {image_id}.
        slots:
          oid: path.oid
          image_id: requestBody.image_id
          scheduled_download: requestBody.scheduled_download
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connectors/{oid}/scheduled-upgrade'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a connector upgrade
      effect: write
      questions:
      - How do I schedule a ZTNA connector to upgrade to a new image?
      - Can I schedule the image download separately from the upgrade itself?
      instructions:
      - text: Schedule connector {oid} to upgrade to image {image_id}.
        slots:
          oid: path.oid
          image_id: requestBody.image_id
      - text: Plan a new upgrade of connector {oid} to image {image_id}, downloading at {scheduled_download} and upgrading at {scheduled_upgrade}.
        slots:
          oid: path.oid
          image_id: requestBody.image_id
          scheduled_download: requestBody.scheduled_download
          scheduled_upgrade: requestBody.scheduled_upgrade
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connectors/{oid}/scheduled-upgrade'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a connector's scheduled upgrade
      effect: destructive
      questions:
      - How do I cancel an upgrade I scheduled on a ZTNA connector?
      - Can I drop a pending connector upgrade so it never runs?
      instructions:
      - text: Cancel the scheduled upgrade on connector {oid}.
        slots:
          oid: path.oid
      - text: Remove the pending upgrade schedule from connector {oid}.
        slots:
          oid: path.oid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connectors/{oid}/scheduled-upgrade-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a connector upgrade's progress
      effect: read
      questions:
      - Did the scheduled upgrade on my connector succeed or fail?
      - Where can I see the detailed progress of a connector's scheduled upgrade?
      instructions:
      - text: Check whether connector {oid}'s upgrade has succeeded, failed or is still running.
        slots:
          oid: path.oid
      - text: Report how far along connector {oid}'s upgrade is.
        slots:
          oid: path.oid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connectors/{oid}/pcaps'].get
  update:
    x-apievangelist-phrasing:
      intent: List a connector's packet capture files
      effect: read
      questions:
      - Which packet capture files are stored on a ZTNA connector?
      - Can I see the pcaps already captured on a connector before downloading one?
      instructions:
      - text: List the packet capture files on connector {oid}.
        slots:
          oid: path.oid
      - text: Show every pcap recorded on connector {oid}.
        slots:
          oid: path.oid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connectors/{oid}/pcaps'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a packet capture on a connector
      effect: write
      questions:
      - How do I capture packets on a ZTNA connector to troubleshoot traffic?
      - Can I limit a connector packet capture to one host, port or protocol?
      instructions:
      - text: Start a packet capture on interface {interface} of connector {oid}.
        slots:
          oid: path.oid
          interface: requestBody.interface
      - text: Capture {protocol} traffic to {host} port {port} on connector {oid} interface {interface}.
        slots:
          oid: path.oid
          interface: requestBody.interface
          host: requestBody.host
          port: requestBody.port
          protocol: requestBody.protocol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connectors/{oid}/pcaps/{id}:stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a running packet capture
      effect: write
      questions:
      - How do I stop a packet capture that is still running on a connector?
      - Can I end an in-progress connector capture early?
      instructions:
      - text: Stop packet capture {id} on connector {oid}.
        slots:
          oid: path.oid
          id: path.id
      - text: End the in-progress capture {id} running on connector {oid}.
        slots:
          oid: path.oid
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connectors/{oid}/pcaps/{id}:download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a connector packet capture
      effect: read
      questions:
      - How do I get a pcap file off a ZTNA connector to open in Wireshark?
      - Can I download a finished packet capture from a connector?
      instructions:
      - text: Download packet capture file {id} from connector {oid}.
        slots:
          oid: path.oid
          id: path.id
      - text: Fetch the pcap {id} captured on connector {oid}.
        slots:
          oid: path.oid
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connectors/{oid}/tech-support-files'].get
  update:
    x-apievangelist-phrasing:
      intent: List a connector's tech support files
      effect: read
      questions:
      - Which tech support dumps are available on a ZTNA connector?
      - Can I see the tech-support files a connector has already generated?
      instructions:
      - text: List the tech support files on connector {oid}.
        slots:
          oid: path.oid
      - text: Show the available dump tech-support files for connector {oid}.
        slots:
          oid: path.oid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connectors/{oid}/tech-support-files'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a connector tech support file
      effect: write
      questions:
      - How do I generate a tech support bundle from a ZTNA connector for a support case?
      - Can I trigger dump tech-support on a connector remotely?
      instructions:
      - text: Generate a tech support file on connector {oid}.
        slots:
          oid: path.oid
      - text: Run dump tech-support on connector {oid}.
        slots:
          oid: path.oid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connectors/{oid}/tech-support-files/{id}:stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop tech support file generation
      effect: write
      questions:
      - How do I cancel a tech support dump that is still being generated on a connector?
      - Can I stop an in-progress tech-support generation?
      instructions:
      - text: Stop tech support generation {id} on connector {oid}.
        slots:
          oid: path.oid
          id: path.id
      - text: Halt the running tech-support job {id} on connector {oid}.
        slots:
          oid: path.oid
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connectors/{oid}/tech-support-files/{id}:download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a connector tech support file
      effect: read
      questions:
      - How do I download a generated tech support file from a ZTNA connector?
      - Can I pull a connector's tech-support dump to attach to a ticket?
      instructions:
      - text: Download tech support file {id} from connector {oid}.
        slots:
          oid: path.oid
          id: path.id
      - text: Fetch the tech-support dump {id} from connector {oid}.
        slots:
          oid: path.oid
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connector-images'].get
  update:
    x-apievangelist-phrasing:
      intent: List available connector image versions
      effect: read
      questions:
      - Which ZTNA connector software image versions can I upgrade to?
      - What is the newest connector image available in Palo Alto Networks Prisma Access?
      instructions:
      - text: List the available ZTNA connector image versions.
      - text: Show me which connector images I can schedule an upgrade to.
      method: generated
      generated: '2026-09-26'