Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for TLS Protect Cloud API for Strata Cloud Manager Plugins…

9 actions 9 updates phrasing extends openapi/palo-alto-networks-plugins-connectors-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 9

$.info
$.paths['/v1/plugins'].get
$.paths['/v1/plugins'].post
$.paths['/v1/plugins/{id}'].get
$.paths['/v1/plugins/{id}'].delete
$.paths['/v1/plugins/{id}'].patch
$.paths['/v1/plugins/{id}/disablements'].post
$.paths['/v1/plugins/{id}/disablements'].delete
$.paths['/v1/plugins/disablements'].get

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 TLS Protect Cloud API for Strata Cloud Manager Plugins…
  version: 1.0.0
extends: openapi/palo-alto-networks-plugins-connectors-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: 8
- target: $.paths['/v1/plugins'].get
  update:
    x-apievangelist-phrasing:
      intent: List plugins for the tenant
      effect: read
      questions:
      - Which plugins and connectors are available in my tenant?
      - Can I include disabled plugins when listing them?
      instructions:
      - text: List all plugins of type {pluginTypes}.
        slots:
          pluginTypes: query.pluginTypes
      - text: List every plugin, including disabled ones.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/plugins'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom tenant plugin
      effect: write
      questions:
      - How do I add my own custom plugin for exclusive use in my tenant?
      - What role do I need to create a local plugin?
      instructions:
      - text: Create a {pluginType} plugin from manifest {manifest}.
        slots:
          pluginType: requestBody.pluginType
          manifest: requestBody.manifest
      - text: Add a local plugin of type {pluginType} with manifest {manifest} maintained by {maintainer}.
        slots:
          pluginType: requestBody.pluginType
          manifest: requestBody.manifest
          maintainer: requestBody.maintainer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/plugins/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a plugin
      effect: read
      questions:
      - How do I look up the details of one plugin?
      - What does a specific plugin's record contain?
      instructions:
      - text: Get plugin {id}.
        slots:
          id: path.id
      - text: Show the details of plugin {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/plugins/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom tenant plugin
      effect: destructive
      questions:
      - Can I permanently delete a local plugin my tenant owns?
      - How do I get rid of a custom plugin I created?
      instructions:
      - text: Delete local plugin {id}.
        slots:
          id: path.id
      - text: Permanently remove custom plugin {id} from my tenant.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/plugins/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a custom tenant plugin
      effect: write
      questions:
      - How do I change the manifest or image of a local plugin?
      - Can I update who maintains a custom plugin?
      instructions:
      - text: Update plugin {id} with manifest {manifest}.
        slots:
          id: path.id
          manifest: requestBody.manifest
      - text: Set the maintainer of plugin {id} to {maintainer}.
        slots:
          id: path.id
          maintainer: requestBody.maintainer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/plugins/{id}/disablements'].post
  update:
    x-apievangelist-phrasing:
      intent: Disable a plugin for the tenant
      effect: write
      questions:
      - How do I turn off a plugin without deleting it?
      - Can I disable a built-in plugin for my tenant only?
      instructions:
      - text: Disable plugin {id} for my tenant.
        slots:
          id: path.id
      - text: Turn off plugin {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/plugins/{id}/disablements'].delete
  update:
    x-apievangelist-phrasing:
      intent: Re-enable a disabled plugin
      effect: destructive
      questions:
      - How do I turn a disabled plugin back on?
      - Can I remove the disablement on a plugin?
      instructions:
      - text: Re-enable plugin {id}.
        slots:
          id: path.id
      - text: Remove the disablement from plugin {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/plugins/disablements'].get
  update:
    x-apievangelist-phrasing:
      intent: List disabled plugins
      effect: read
      questions:
      - Which plugins are currently disabled in my tenant?
      - What plugins have we turned off?
      instructions:
      - text: List all disabled plugins.
      - text: Show plugins switched off for this tenant.
      method: generated
      generated: '2026-09-26'