Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ZTNA Connector Restful Connector Group API

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

$.info
$.paths['/sse/connector/v2.0/api/connector-groups'].get
$.paths['/sse/connector/v2.0/api/connector-groups'].post
$.paths['/sse/connector/v2.0/api/connector-groups/{oid}'].get
$.paths['/sse/connector/v2.0/api/connector-groups/{oid}'].put
$.paths['/sse/connector/v2.0/api/connector-groups/{oid}'].delete
$.paths['/sse/connector/v2.0/api/connector-groups/filters'].get
$.paths['/sse/connector/v2.0/api/connector-groups/{oid}/connectors'].get
$.paths['/sse/connector/v2.0/api/connector-groups/{oid}/applications'].get
$.paths['/sse/connector/v2.0/api/connector-groups/{oid}/subnets'].get
$.paths['/sse/connector/v2.0/api/connector-groups/{oid}/wildcards'].get
$.paths['/sse/connector/v2.0/api/connector-groups/{oid}/scheduled-upgrade'].get
$.paths['/sse/connector/v2.0/api/connector-groups/{oid}/scheduled-upgrade'].put
$.paths['/sse/connector/v2.0/api/connector-groups/{oid}/scheduled-upgrade'].post
$.paths['/sse/connector/v2.0/api/connector-groups/{oid}/scheduled-upgrade'].delete
$.paths['/sse/connector/v2.0/api/connector-groups/{oid}/scheduled-upgrade-status'].get

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 ZTNA Connector Restful Connector Group API
  version: 1.0.0
extends: openapi/palo-alto-networks-connector-group-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: 15
- target: $.paths['/sse/connector/v2.0/api/connector-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List connector groups
      effect: read
      questions:
      - What connector groups do I have set up for private app access?
      - Can I search and sort my connector groups by name?
      instructions:
      - text: List all my connector groups.
      - text: Search connector groups for {search}, returning at most {limit}.
        slots:
          search: query.search
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connector-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a connector group
      effect: write
      questions:
      - How do I create a new connector group in Palo Alto Networks ZTNA Connector?
      - Can I turn on autoscaling when I create a connector group?
      instructions:
      - text: Create a connector group named {name}.
        slots:
          name: requestBody.name
      - text: Create connector group {name} described as {description} with autoscale set to {is_autoscale}.
        slots:
          name: requestBody.name
          description: requestBody.description
          is_autoscale: requestBody.is_autoscale
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connector-groups/{oid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a connector group
      effect: read
      questions:
      - What are the settings of a single connector group?
      - Can I look up one connector group by its object id?
      instructions:
      - text: Show connector group {oid}.
        slots:
          oid: path.oid
      - text: Get the configuration details of connector group {oid}.
        slots:
          oid: path.oid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connector-groups/{oid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a connector group
      effect: write
      questions:
      - How do I rename an existing connector group?
      - Can I enable user ID preservation on a connector group that already exists?
      instructions:
      - text: Rename connector group {oid} to {name}.
        slots:
          oid: path.oid
          name: requestBody.name
      - text: Set preserve user ID to {preserve_user_id} on existing connector group {oid}.
        slots:
          preserve_user_id: requestBody.preserve_user_id
          oid: path.oid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connector-groups/{oid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a connector group
      effect: destructive
      questions:
      - How do I remove a connector group I no longer need?
      - Can I delete a connector group by its id?
      instructions:
      - text: Delete connector group {oid}.
        slots:
          oid: path.oid
      - text: Remove the connector group with id {oid} permanently.
        slots:
          oid: path.oid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connector-groups/filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List filter values for connector group fields
      effect: read
      questions:
      - What values can I filter connector groups on for a given field?
      - Which filter options are available for the connector group list?
      instructions:
      - text: Get the filter values for connector group field {field}.
        slots:
          field: query.field
      - text: List connector group filter options.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connector-groups/{oid}/connectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List connectors in a connector group
      effect: read
      questions:
      - Which connectors belong to a particular connector group?
      - Can I search the connectors inside one group?
      instructions:
      - text: List the connectors in connector group {oid}.
        slots:
          oid: path.oid
      - text: Search connectors in group {oid} for {search}.
        slots:
          oid: path.oid
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connector-groups/{oid}/applications'].get
  update:
    x-apievangelist-phrasing:
      intent: List FQDN applications served by a connector group
      effect: read
      questions:
      - Which FQDN applications are routed through a connector group?
      - What application domains does one connector group give access to?
      instructions:
      - text: List the FQDN applications for connector group {oid}.
        slots:
          oid: path.oid
      - text: Search the FQDN rules of connector group {oid} for {search}.
        slots:
          oid: path.oid
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connector-groups/{oid}/subnets'].get
  update:
    x-apievangelist-phrasing:
      intent: List subnets served by a connector group
      effect: read
      questions:
      - Which subnets are reachable through a given connector group?
      - Can I sort the subnet rules of a connector group?
      instructions:
      - text: List the subnets for connector group {oid}.
        slots:
          oid: path.oid
      - text: Show subnet rules in connector group {oid} sorted by {sort}.
        slots:
          oid: path.oid
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connector-groups/{oid}/wildcards'].get
  update:
    x-apievangelist-phrasing:
      intent: List wildcard domains served by a connector group
      effect: read
      questions:
      - What wildcard domain rules are attached to a connector group?
      - Which wildcard applications route through one connector group?
      instructions:
      - text: List the wildcard rules for connector group {oid}.
        slots:
          oid: path.oid
      - text: Search wildcards in connector group {oid} for {search}.
        slots:
          oid: path.oid
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connector-groups/{oid}/scheduled-upgrade'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a connector group's scheduled upgrade
      effect: read
      questions:
      - When is the next connector software upgrade scheduled for a group?
      - What image and timing are set in a connector group's upgrade schedule?
      instructions:
      - text: Show the scheduled upgrade for connector group {oid}.
        slots:
          oid: path.oid
      - text: Get the upgrade schedule settings of connector group {oid}.
        slots:
          oid: path.oid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connector-groups/{oid}/scheduled-upgrade'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a connector group's scheduled upgrade
      effect: write
      questions:
      - How do I change the image or time of an upgrade already scheduled for a connector group?
      - Can I switch an existing scheduled upgrade to a rolling upgrade?
      instructions:
      - text: Change the existing scheduled upgrade of connector group {oid} to image {image_id}.
        slots:
          oid: path.oid
          image_id: requestBody.image_id
      - text: Reschedule the upgrade of group {oid} to image {image_id} at {scheduled_upgrade}.
        slots:
          oid: path.oid
          image_id: requestBody.image_id
          scheduled_upgrade: requestBody.scheduled_upgrade
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connector-groups/{oid}/scheduled-upgrade'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule an upgrade for a connector group
      effect: write
      questions:
      - How do I schedule a connector software upgrade for a group that has none yet?
      - Can I set a drain timeout when scheduling a new connector upgrade?
      instructions:
      - text: Schedule a new upgrade of connector group {oid} to image {image_id}.
        slots:
          oid: path.oid
          image_id: requestBody.image_id
      - text: Set up a rolling upgrade {rolling_upgrade} for group {oid} to image {image_id} with drain timeout {drain_timeout}.
        slots:
          rolling_upgrade: requestBody.rolling_upgrade
          oid: path.oid
          image_id: requestBody.image_id
          drain_timeout: requestBody.drain_timeout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connector-groups/{oid}/scheduled-upgrade'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a connector group's scheduled upgrade
      effect: destructive
      questions:
      - How do I cancel an upgrade scheduled for a connector group?
      - Can I remove a pending connector upgrade schedule?
      instructions:
      - text: Cancel the scheduled upgrade for connector group {oid}.
        slots:
          oid: path.oid
      - text: Delete the upgrade schedule on connector group {oid}.
        slots:
          oid: path.oid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/connector-groups/{oid}/scheduled-upgrade-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the upgrade status of a connector group
      effect: read
      questions:
      - Did the scheduled upgrade finish on every connector in the group?
      - What is the upgrade progress of each connector in a connector group?
      instructions:
      - text: Check the scheduled upgrade status of connector group {oid}.
        slots:
          oid: path.oid
      - text: Show per-connector upgrade progress for group {oid}.
        slots:
          oid: path.oid
      method: generated
      generated: '2026-09-26'