Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ZTNA Connector Restful FQDN API

7 actions 7 updates phrasing extends openapi/palo-alto-networks-fqdn-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['/sse/connector/v2.0/api/applications'].get

$.paths['/sse/connector/v2.0/api/applications'].post

$.paths['/sse/connector/v2.0/api/applications/{oid}'].get

$.paths['/sse/connector/v2.0/api/applications/{oid}'].put

$.paths['/sse/connector/v2.0/api/applications/{oid}'].delete

$.paths['/sse/connector/v2.0/api/applications/filters'].get

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 ZTNA Connector Restful FQDN API
  version: 1.0.0
extends: openapi/palo-alto-networks-fqdn-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['/sse/connector/v2.0/api/applications'].get
  update:
    x-apievangelist-phrasing:
      intent: List FQDN-based applications
      effect: read
      questions:
      - Which FQDN applications are published through my ZTNA connectors?
      - Can I search and sort my FQDN application rules?
      instructions:
      - text: List my FQDN applications matching {search}.
        slots:
          search: query.search
      - text: Show FQDN applications in region {region}, {limit} per page sorted by {sort}.
        slots:
          region: header.x-panw-region
          limit: query.limit
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/applications'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an FQDN-based application
      effect: write
      questions:
      - How do I publish a new application by FQDN through a connector group?
      - Can I allow ICMP to a new FQDN application?
      instructions:
      - text: Create FQDN application {name} in connector group {group} with spec {spec}.
        slots:
          name: requestBody.name
          group: requestBody.group
          spec: requestBody.spec
      - text: Add FQDN app {name} to group {group} using spec {spec} with ICMP allowed {icmp_allowed}.
        slots:
          name: requestBody.name
          group: requestBody.group
          spec: requestBody.spec
          icmp_allowed: requestBody.icmp_allowed
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/applications/{oid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an FQDN-based application
      effect: read
      questions:
      - What's configured on one FQDN application?
      - Can I fetch a single FQDN rule by its object ID?
      instructions:
      - text: Get FQDN application {oid}.
        slots:
          oid: path.oid
      - text: Show the spec and connector group of FQDN rule {oid}.
        slots:
          oid: path.oid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/applications/{oid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an FQDN-based application
      effect: write
      questions:
      - Can I turn off an FQDN application without deleting it?
      - What do I need to send to change which connector group serves an FQDN app?
      instructions:
      - text: Move FQDN application {oid} named {name} to connector group {group}.
        slots:
          oid: path.oid
          name: requestBody.name
          group: requestBody.group
      - text: Set FQDN app {oid} ({name}, group {group}) enabled to {app_enabled}.
        slots:
          oid: path.oid
          name: requestBody.name
          group: requestBody.group
          app_enabled: requestBody.app_enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/applications/{oid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an FQDN-based application
      effect: destructive
      questions:
      - How do I remove an FQDN application from my connectors?
      - Can I delete an FQDN rule by its object ID?
      instructions:
      - text: Delete FQDN application {oid}.
        slots:
          oid: path.oid
      - text: Remove FQDN rule {oid} in region {region}.
        slots:
          oid: path.oid
          region: header.x-panw-region
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/applications/filters'].get
  update:
    x-apievangelist-phrasing:
      intent: Get filter values for FQDN rule fields
      effect: read
      questions:
      - What values can I filter FQDN applications by for a given field?
      - Which filter options exist for the FQDN rule group field?
      instructions:
      - text: Get the filter values for FQDN rule field {field}.
        slots:
          field: query.field
      - text: Suggest FQDN filter values for field {field} matching {search}.
        slots:
          field: query.field
          search: query.search
      method: generated
      generated: '2026-09-26'