Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tenant Service Group API

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

$.info
$.paths['/tenancy/v1/tenant_service_groups'].get
$.paths['/tenancy/v1/tenant_service_groups'].post
$.paths['/tenancy/v1/tenant_service_groups/{tsg_id}'].get
$.paths['/tenancy/v1/tenant_service_groups/{tsg_id}'].put
$.paths['/tenancy/v1/tenant_service_groups/{tsg_id}'].delete
$.paths['/tenancy/v1/tenant_service_groups/{tsg_id}/operations/list_ancestors'].post
$.paths['/tenancy/v1/tenant_service_groups/{tsg_id}/operations/list_children'].post

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 Tenant Service Group API
  version: 1.0.0
extends: openapi/palo-alto-networks-tenantservicegroup-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: 7
- target: $.paths['/tenancy/v1/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 get the tenant service groups as a hierarchy instead of a flat list?
      instructions:
      - text: List all tenant service groups available to me.
      - text: List tenant service groups with hierarchy set to {hierarchy}.
        slots:
          hierarchy: query.hierarchy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenancy/v1/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 a parent TSG?
      - What access does my service account get on a tenant service group it creates?
      instructions:
      - text: Create tenant service group {display_name} under parent {parent_id}.
        slots:
          display_name: requestBody.display_name
          parent_id: requestBody.parent_id
      - text: Create TSG {display_name} with support contact {support_contact} and vertical {vertical}.
        slots:
          display_name: requestBody.display_name
          support_contact: requestBody.support_contact
          vertical: requestBody.vertical
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenancy/v1/tenant_service_groups/{tsg_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tenant service group
      effect: read
      questions:
      - How do I look up a tenant service group by TSG ID?
      - What display name and support contact does a given TSG have?
      instructions:
      - text: Get tenant service group {tsg_id}.
        slots:
          tsg_id: path.tsg_id
      - text: Show the details of TSG {tsg_id}.
        slots:
          tsg_id: path.tsg_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenancy/v1/tenant_service_groups/{tsg_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a tenant service group
      effect: write
      questions:
      - Can I change the display name or support contact of a tenant service group?
      - Why does updating a TSG fail when my token is for a different TSG?
      instructions:
      - text: Rename tenant service group {tsg_id} to {display_name}.
        slots:
          tsg_id: path.tsg_id
          display_name: requestBody.display_name
      - text: Set the support contact of TSG {tsg_id} to {support_contact}.
        slots:
          tsg_id: path.tsg_id
          support_contact: requestBody.support_contact
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenancy/v1/tenant_service_groups/{tsg_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tenant service group
      effect: destructive
      questions:
      - How do I delete a tenant service group?
      - Does the access token have to match the TSG I'm deleting?
      instructions:
      - text: Delete tenant service group {tsg_id}.
        slots:
          tsg_id: path.tsg_id
      - text: Remove TSG {tsg_id} permanently.
        slots:
          tsg_id: path.tsg_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenancy/v1/tenant_service_groups/{tsg_id}/operations/list_ancestors'].post
  update:
    x-apievangelist-phrasing:
      intent: List a tenant's ancestor TSGs
      effect: read
      questions:
      - What are the parent tenants above a given TSG, up to the root?
      - Can I order a TSG's ancestors from root to leaf and include the TSG itself?
      instructions:
      - text: List the ancestors of TSG {tsg_id}.
        slots:
          tsg_id: path.tsg_id
      - text: Show ancestors of tenant service group {tsg_id} sorted {sort}, include_self {include_self}.
        slots:
          tsg_id: path.tsg_id
          sort: query.sort
          include_self: query.include_self
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenancy/v1/tenant_service_groups/{tsg_id}/operations/list_children'].post
  update:
    x-apievangelist-phrasing:
      intent: List a tenant's child TSGs
      effect: read
      questions:
      - Which child tenants sit directly under a tenant service group?
      - Can I get the whole descendant tree of a TSG rather than just its immediate children?
      instructions:
      - text: List the child tenants of TSG {tsg_id}.
        slots:
          tsg_id: path.tsg_id
      - text: Show every descendant of tenant service group {tsg_id} with hierarchy {hierarchy}.
        slots:
          tsg_id: path.tsg_id
          hierarchy: query.hierarchy
      method: generated
      generated: '2026-09-26'