Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Permissions API

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

$.info

$.paths['/iam/v1/permissions'].get

$.paths['/iam/v1/permissions/{name}'].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 Permissions API
  version: 1.0.0
extends: openapi/palo-alto-networks-permissions-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: 2
- target: $.paths['/iam/v1/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List access permissions
      effect: read
      questions:
      - What IAM permissions exist in the Palo Alto Networks platform?
      - Can I list permissions for one service only?
      instructions:
      - text: List permissions for service {service}.
        slots:
          service: query.service
      - text: Show permissions allowing action {action} on resource {resource}.
        slots:
          action: query.action
          resource: query.resource
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v1/permissions/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a permission
      effect: read
      questions:
      - What does a specific service.resource.action permission grant?
      - Can I look up a single permission by name?
      instructions:
      - text: Get permission {name}.
        slots:
          name: path.name
      - text: Show details of the permission named {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'