Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ZTNA Connector Restful Tenant API

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

$.info

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

$.paths['/sse/connector/v2.0/api/tenant:start-onboarding'].post

$.paths['/sse/connector/v2.0/api/tenant:start-offboarding'].post

$.paths['/sse/connector/v2.0/api/tenant:status'].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 Tenant API
  version: 1.0.0
extends: openapi/palo-alto-networks-tenant-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: 4
- target: $.paths['/sse/connector/v2.0/api/license'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the tenant's license details
      effect: read
      questions:
      - What license does my SSE connector tenant currently have?
      - Can I check license details for a tenant in a specific region?
      instructions:
      - text: Show the license details for my tenant.
      - text: Get tenant license info for region {region}.
        slots:
          region: header.x-panw-region
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/tenant:start-onboarding'].post
  update:
    x-apievangelist-phrasing:
      intent: Start onboarding a tenant
      effect: write
      questions:
      - How do I kick off onboarding for a new SSE connector tenant?
      - Can tenant onboarding be started for a particular region?
      instructions:
      - text: Start onboarding my tenant.
      - text: Begin tenant onboarding in region {region}.
        slots:
          region: header.x-panw-region
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/tenant:start-offboarding'].post
  update:
    x-apievangelist-phrasing:
      intent: Offboard and delete a tenant
      effect: destructive
      questions:
      - How do I mark my tenant for deletion and trigger cleanup?
      - What happens when tenant offboarding is started?
      instructions:
      - text: Start offboarding my tenant so it is deleted.
      - text: Mark the tenant in region {region} for deletion.
        slots:
          region: header.x-panw-region
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/connector/v2.0/api/tenant:status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the tenant's current status
      effect: read
      questions:
      - Is my tenant still onboarding, active, or being deleted?
      - Where can I see the current state of the tenant?
      instructions:
      - text: Get the current status of my tenant.
      - text: Check tenant status in region {region}.
        slots:
          region: header.x-panw-region
      method: generated
      generated: '2026-09-26'