Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks AIOps for NGFW BPA 5G Deregistered Trend…

7 actions 7 updates phrasing extends openapi/palo-alto-networks-tenant-service-groups-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['/tenant-service-groups'].get

$.paths['/tenant-service-groups'].post

$.paths['/tenant-service-groups/{tsg_id}'].get

$.paths['/tenant-service-groups/{tsg_id}'].put

$.paths['/tenant-service-groups/{tsg_id}'].delete

$.paths['/tenant-service-groups/{tsg_id}/children'].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 Palo Alto Networks AIOps for NGFW BPA 5G Deregistered Trend…
  version: 1.0.0
extends: openapi/palo-alto-networks-tenant-service-groups-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['/tenant-service-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List Tenant Service Groups
      effect: read
      questions:
      - Which Tenant Service Groups can my service account see?
      - Can I filter the TSG list to the direct children of one parent?
      instructions:
      - text: List the Tenant Service Groups I have access to.
      - text: List TSGs whose parent is {parent_id}, {limit} per page.
        slots:
          parent_id: query.parent_id
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenant-service-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Tenant Service Group
      effect: write
      questions:
      - How do I create a new tenant under an existing TSG?
      - What do I need to set up a Tenant Service Group in the hierarchy?
      instructions:
      - text: Create a TSG named {display_name} under parent {parent_id}.
        slots:
          display_name: requestBody.display_name
          parent_id: requestBody.parent_id
      - text: Add tenant {display_name} below {parent_id} in region {region}.
        slots:
          display_name: requestBody.display_name
          parent_id: requestBody.parent_id
          region: requestBody.region
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenant-service-groups/{tsg_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Tenant Service Group details
      effect: read
      questions:
      - What licenses and status does a specific Tenant Service Group have?
      - Can I see a TSG's parent and description?
      instructions:
      - text: Show the details of TSG {tsg_id}.
        slots:
          tsg_id: path.tsg_id
      - text: Get license allocations and status for tenant service group {tsg_id}.
        slots:
          tsg_id: path.tsg_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenant-service-groups/{tsg_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Tenant Service Group
      effect: write
      questions:
      - How do I rename a Tenant Service Group?
      - Can I change a TSG's parent after it's created?
      instructions:
      - text: Rename TSG {tsg_id} to {display_name}.
        slots:
          tsg_id: path.tsg_id
          display_name: requestBody.display_name
      - text: Update the description of tenant service group {tsg_id} to {description}.
        slots:
          tsg_id: path.tsg_id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenant-service-groups/{tsg_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Tenant Service Group
      effect: destructive
      questions:
      - How do I permanently remove a Tenant Service Group?
      - Can I delete a TSG that still has child tenants or active subscriptions?
      instructions:
      - text: Delete TSG {tsg_id}.
        slots:
          tsg_id: path.tsg_id
      - text: Permanently remove tenant service group {tsg_id}.
        slots:
          tsg_id: path.tsg_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenant-service-groups/{tsg_id}/children'].get
  update:
    x-apievangelist-phrasing:
      intent: List child TSGs of a Tenant Service Group
      effect: read
      questions:
      - Which tenants sit directly under a given TSG?
      - How can I walk down a multi-level tenant hierarchy?
      instructions:
      - text: List the direct children of TSG {tsg_id}.
        slots:
          tsg_id: path.tsg_id
      - text: Show up to {limit} child tenants under {tsg_id}.
        slots:
          limit: query.limit
          tsg_id: path.tsg_id
      method: generated
      generated: '2026-09-26'