Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Prisma AIRS API Management service AI Sec Profile API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-ai-sec-profile-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 6

$.info

$.paths['/v1/mgmt/profile'].post

$.paths['/v1/mgmt/profile/{profile_id}'].delete

$.paths['/v1/mgmt/profile/uuid/{profile_id}'].put

$.paths['/v1/mgmt/profiles'].get

$.paths['/v1/mgmt/profile/{profile_id}/force'].delete

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 Prisma AIRS API Management service AI Sec Profile API
  version: 1.0.0
extends: openapi/palo-alto-networks-ai-sec-profile-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: 5
- target: $.paths['/v1/mgmt/profile'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an AI security profile
      effect: write
      questions:
      - How do I create a new AI security profile with its own policy?
      - What fields are required to add an AI security profile?
      instructions:
      - text: Create AI security profile {profile_name} at revision {revision} with policy {policy}.
        slots:
          profile_name: requestBody.profile_name
          revision: requestBody.revision
          policy: requestBody.policy
      - text: Add an active AI profile named {profile_name}, revision {revision}, using policy {policy}.
        slots:
          profile_name: requestBody.profile_name
          revision: requestBody.revision
          policy: requestBody.policy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/mgmt/profile/{profile_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an AI security profile
      effect: destructive
      questions:
      - How do I delete an AI security profile normally, with safety checks?
      - Can I remove an AI profile by its ID?
      instructions:
      - text: Delete AI security profile {profile_id}.
        slots:
          profile_id: path.profile_id
      - text: Remove AI profile {profile_id} if it's safe to do so.
        slots:
          profile_id: path.profile_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/mgmt/profile/uuid/{profile_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an AI security profile
      effect: write
      questions:
      - How do I change the policy or name of an existing AI security profile?
      - Can I bump an AI profile to a new revision?
      instructions:
      - text: Update AI profile {profile_id} to name {profile_name}, revision {revision}, policy {policy}.
        slots:
          profile_id: path.profile_id
          profile_name: requestBody.profile_name
          revision: requestBody.revision
          policy: requestBody.policy
      - text: Modify profile {profile_id}'s policy to {policy} as revision {revision} named {profile_name}.
        slots:
          profile_id: path.profile_id
          policy: requestBody.policy
          revision: requestBody.revision
          profile_name: requestBody.profile_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/mgmt/profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List AI security profiles
      effect: read
      questions:
      - Which AI security profiles exist for my tenant service group?
      - Can I list only the latest revision of each AI profile?
      instructions:
      - text: List all AI security profiles for my TSG.
      - text: Show {limit} AI profiles from offset {offset}, latest revisions only {latest}.
        slots:
          limit: query.limit
          offset: query.offset
          latest: query.latest
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/mgmt/profile/{profile_id}/force'].delete
  update:
    x-apievangelist-phrasing:
      intent: Force delete an AI security profile
      effect: destructive
      questions:
      - How do I force-delete an AI profile that won't delete normally?
      - Can I bypass safety checks when removing an AI security profile?
      instructions:
      - text: Force delete AI profile {profile_id} as {updated_by}.
        slots:
          profile_id: path.profile_id
          updated_by: query.updated_by
      - text: Bypass checks and remove AI profile {profile_id}, recorded by {updated_by}.
        slots:
          profile_id: path.profile_id
          updated_by: query.updated_by
      method: generated
      generated: '2026-09-26'