Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Prisma AIRS API Management service Custom Topic API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-custom-topic-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/topic'].post

$.paths['/v1/mgmt/topic/{topic_id}'].delete

$.paths['/v1/mgmt/topic/{topic_id}/force'].delete

$.paths['/v1/mgmt/topic/uuid/{topic_id}'].put

$.paths['/v1/mgmt/topics'].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 Prisma AIRS API Management service Custom Topic API
  version: 1.0.0
extends: openapi/palo-alto-networks-custom-topic-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/topic'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom topic
      effect: write
      questions:
      - How do I define a custom topic with example usages for AI security detection?
      - Can I create a custom topic that starts out disabled?
      instructions:
      - text: Create custom topic {topic_name}, revision {revision}, described as {description} with examples {examples}.
        slots:
          topic_name: requestBody.topic_name
          revision: requestBody.revision
          description: requestBody.description
          examples: requestBody.examples
      - text: Add a new custom topic {topic_name} with active set to {active}.
        slots:
          topic_name: requestBody.topic_name
          active: requestBody.active
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/mgmt/topic/{topic_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom topic
      effect: destructive
      questions:
      - Can I delete a custom topic through the normal safety-checked path?
      - What happens if a custom topic is still in use when I try to delete it?
      instructions:
      - text: Delete custom topic {topic_id}.
        slots:
          topic_id: path.topic_id
      - text: Remove custom topic {topic_id} with the standard safety checks.
        slots:
          topic_id: path.topic_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/mgmt/topic/{topic_id}/force'].delete
  update:
    x-apievangelist-phrasing:
      intent: Force delete a custom topic
      effect: destructive
      questions:
      - Is there a way to force delete a custom topic that fails the normal safety checks?
      - Who is recorded as performing a forced custom topic deletion?
      instructions:
      - text: Force delete custom topic {topic_id} as user {updated_by}.
        slots:
          topic_id: path.topic_id
          updated_by: query.updated_by
      - text: Bypass safety checks and force remove topic {topic_id}, recorded by {updated_by}.
        slots:
          topic_id: path.topic_id
          updated_by: query.updated_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/mgmt/topic/uuid/{topic_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Modify a custom topic
      effect: write
      questions:
      - Can I change the description and examples of an existing custom topic?
      - Is it possible to deactivate a custom topic without deleting it?
      instructions:
      - text: Update custom topic {topic_id} to name {topic_name}, revision {revision}, description {description} and examples {examples}.
        slots:
          topic_id: path.topic_id
          topic_name: requestBody.topic_name
          revision: requestBody.revision
          description: requestBody.description
          examples: requestBody.examples
      - text: Set custom topic {topic_id} active to {active}.
        slots:
          topic_id: path.topic_id
          active: requestBody.active
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/mgmt/topics'].get
  update:
    x-apievangelist-phrasing:
      intent: List all custom topics
      effect: read
      questions:
      - Which custom topics exist for my tenant service group?
      - Can I page through custom topics and their metadata?
      instructions:
      - text: List all custom topics for my TSG.
      - text: Show {limit} custom topics starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-26'