Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Action Plan Management APIs API

13 actions 13 updates phrasing extends openapi/palo-alto-networks-action-plan-management-apis-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 13

$.info
$.paths['/apm/api/v1/action-plan'].post
$.paths['/apm/api/v1/action-plan/{action-plan-id}/status-assignee'].patch
$.paths['/apm/api/v1/action-plan/{action-plan-id}/feedback'].patch
$.paths['/apm/api/v1/action-plan/{action-plan-id}/recommendation-summary'].get
$.paths['/apm/api/v1/action-plan/{action-plan-id}/related-alerts'].get
$.paths['/apm/api/v1/action-plan/{action-plan-id}/impacted-assets'].get
$.paths['/apm/api/v1/action-plan/{action-plan-id}/notification/ondemand'].post
$.paths['/apm/api/v1/action-plan/names'].get
$.paths['/apm/api/v1/filter/action-plan/suggest'].post
$.paths['/apm/api/v1/critical-asset'].post
$.paths['/apm/api/v1/asset-criticality'].post
$.paths['/apm/api/v1/asset-criticality/{asset-id}'].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 Action Plan Management APIs API
  version: 1.0.0
extends: openapi/palo-alto-networks-action-plan-management-apis-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: 12
- target: $.paths['/apm/api/v1/action-plan'].post
  update:
    x-apievangelist-phrasing:
      intent: List action plans by criticality
      effect: read
      questions:
      - What action plans does my tenant have, most critical first?
      - Can I filter and sort the list of remediation action plans?
      instructions:
      - text: List my action plans using token {token}.
        slots:
          token: header.x-redlock-auth
      - text: List {limit} action plans with filters {filters}, authenticating with {token}.
        slots:
          limit: requestBody.limit
          filters: requestBody.filters
          token: header.x-redlock-auth
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apm/api/v1/action-plan/{action-plan-id}/status-assignee'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an action plan's status or assignee
      effect: write
      questions:
      - How do I reassign an action plan to someone else?
      - Can I mark an action plan as resolved by changing its status?
      instructions:
      - text: Assign action plan {plan} to {assignee} using token {token}.
        slots:
          plan: path.action-plan-id
          assignee: requestBody.assignee
          token: header.x-redlock-auth
      - text: Set the status of action plan {plan} to {status} with token {token}.
        slots:
          plan: path.action-plan-id
          status: requestBody.status
          token: header.x-redlock-auth
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apm/api/v1/action-plan/{action-plan-id}/feedback'].patch
  update:
    x-apievangelist-phrasing:
      intent: Give thumbs up or down feedback on an action plan
      effect: write
      questions:
      - Can I tell Prisma Cloud an action plan wasn't useful?
      - How do I leave thumbs-down reasons on an action plan?
      instructions:
      - text: Give action plan {plan} a thumbs {thumbsUpDown} with token {token}.
        slots:
          plan: path.action-plan-id
          thumbsUpDown: requestBody.thumbsUpDown
          token: header.x-redlock-auth
      - text: 'Record thumbs-down feedback on action plan {plan}: {reason}, token {token}.'
        slots:
          plan: path.action-plan-id
          reason: requestBody.thumbsDownDescription
          token: header.x-redlock-auth
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apm/api/v1/action-plan/{action-plan-id}/recommendation-summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize remediation recommendations for a plan
      effect: read
      questions:
      - What do the policy recommendations behind an action plan add up to?
      - Is there a single summary of how to remediate an action plan?
      instructions:
      - text: Summarize recommendations for action plan {plan} with token {token}.
        slots:
          plan: path.action-plan-id
          token: header.x-redlock-auth
      - text: Get the recommendation summary of plan {plan} using token {token}.
        slots:
          plan: path.action-plan-id
          token: header.x-redlock-auth
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apm/api/v1/action-plan/{action-plan-id}/related-alerts'].get
  update:
    x-apievangelist-phrasing:
      intent: List alerts related to an action plan
      effect: read
      questions:
      - Which alerts are tied to a given action plan?
      - How do I page through the alerts behind an action plan?
      instructions:
      - text: List alerts related to action plan {plan} with token {token}.
        slots:
          plan: path.action-plan-id
          token: header.x-redlock-auth
      - text: Show {limit} related alerts for plan {plan}, token {token}.
        slots:
          limit: query.limit
          plan: path.action-plan-id
          token: header.x-redlock-auth
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apm/api/v1/action-plan/{action-plan-id}/impacted-assets'].get
  update:
    x-apievangelist-phrasing:
      intent: List assets impacted by an action plan
      effect: read
      questions:
      - Which cloud assets are affected by an action plan?
      - Can I page through impacted assets sorted by asset ID?
      instructions:
      - text: List impacted assets for action plan {plan} with token {token}.
        slots:
          plan: path.action-plan-id
          token: header.x-redlock-auth
      - text: Show {limit} assets impacted by plan {plan}, token {token}.
        slots:
          limit: query.limit
          plan: path.action-plan-id
          token: header.x-redlock-auth
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apm/api/v1/action-plan/{action-plan-id}/notification/ondemand'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a Jira or Slack notification for a plan
      effect: write
      questions:
      - How do I push an action plan to Jira or Slack on demand?
      - Can I notify my team in Slack about a specific action plan right now?
      instructions:
      - text: Send a notification for action plan {plan} using config {config} and token {token}.
        slots:
          plan: path.action-plan-id
          config: requestBody.onDemandNotificationConfig
          token: header.x-redlock-auth
      - text: Notify Jira about plan {plan} with notification config {config}, token {token}.
        slots:
          plan: path.action-plan-id
          config: requestBody.onDemandNotificationConfig
          token: header.x-redlock-auth
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apm/api/v1/action-plan/names'].get
  update:
    x-apievangelist-phrasing:
      intent: List action plan names
      effect: read
      questions:
      - What are the names of all my action plans?
      - Can I get just the action plan names without their details?
      instructions:
      - text: List action plan names using token {token}.
        slots:
          token: header.x-redlock-auth
      - text: Get every action plan name with auth token {token}.
        slots:
          token: header.x-redlock-auth
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apm/api/v1/filter/action-plan/suggest'].post
  update:
    x-apievangelist-phrasing:
      intent: Suggest action plan filter values
      effect: read
      questions:
      - What values can I pick for an action plan filter in the UI?
      - Which filter suggestions exist for narrowing action plans?
      instructions:
      - text: Suggest values for action plan filter {filterName} with token {token}.
        slots:
          filterName: requestBody.filterName
          token: header.x-redlock-auth
      - text: Autocomplete {query} in action plan filter {filterName}, token {token}.
        slots:
          query: requestBody.query
          filterName: requestBody.filterName
          token: header.x-redlock-auth
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apm/api/v1/critical-asset'].post
  update:
    x-apievangelist-phrasing:
      intent: List business-critical assets
      effect: read
      questions:
      - Which of my assets are marked business critical?
      - Can I filter the list of critical assets?
      instructions:
      - text: List critical assets using token {token}.
        slots:
          token: header.x-redlock-auth
      - text: Show {limit} business-critical assets matching {filters}, token {token}.
        slots:
          limit: requestBody.limit
          filters: requestBody.filters
          token: header.x-redlock-auth
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apm/api/v1/asset-criticality'].post
  update:
    x-apievangelist-phrasing:
      intent: Set business criticality on assets
      effect: write
      questions:
      - How do I mark several assets as high business criticality?
      - Can I change the criticality level for a batch of asset IDs?
      instructions:
      - text: Set criticality {level} on assets {assetIds} with token {token}.
        slots:
          level: requestBody.assetCriticality
          assetIds: requestBody.assetIds
          token: header.x-redlock-auth
      - text: Mark assets {assetIds} as {level} criticality using token {token}.
        slots:
          assetIds: requestBody.assetIds
          level: requestBody.assetCriticality
          token: header.x-redlock-auth
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apm/api/v1/asset-criticality/{asset-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check one asset's business criticality
      effect: read
      questions:
      - How critical is a particular asset to the business?
      - What criticality level is currently set on an asset?
      instructions:
      - text: Check the criticality of asset {asset} with token {token}.
        slots:
          asset: path.asset-id
          token: header.x-redlock-auth
      - text: What criticality is asset {asset} set to? Use token {token}.
        slots:
          asset: path.asset-id
          token: header.x-redlock-auth
      method: generated
      generated: '2026-09-26'