Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Integrations API

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

$.info
$.paths['/integration/search'].get
$.paths['/settings/integration/search'].post
$.paths['/api/v1/tenant/{prismaId}/integration/channels'].get
$.paths['/api/v1/tenant/{prismaId}/integration'].get
$.paths['/api/v1/tenant/{prismaId}/integration'].post
$.paths['/api/v1/tenant/{prismaId}/integration/{id}'].get
$.paths['/api/v1/tenant/{prismaId}/integration/{id}'].put
$.paths['/api/v1/tenant/{prismaId}/integration/{id}'].delete
$.paths['/api/v1/tenant/{prismaId}/integration/{id}'].patch
$.paths['/api/v1/tenant/{prismaId}/integration/test'].post
$.paths['/api/v1/tenant/{prismaId}/integration/securityhub/regions/{accountId}'].get
$.paths['/api/v1/tenant/{prismaId}/integration/securityhub/accounts'].get
$.paths['/v1/jira-integrations'].get
$.paths['/v1/jira-integrations'].post

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 Palo Alto Networks Integrations API
  version: 1.0.0
extends: openapi/palo-alto-networks-integrations-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: 14
- target: $.paths['/integration/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search available integration packs
      effect: read
      questions:
      - Which integration packs are installed in my Cortex XSOAR instance?
      - Can I search installed XSOAR integration packs by name?
      instructions:
      - text: Search installed integration packs for {query}.
        slots:
          query: query.query
      - text: List installed XSOAR integration packs, page {page}.
        slots:
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/integration/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search configured integration instances
      effect: read
      questions:
      - What configured integration instances are connected in XSOAR?
      - Can I find the configured instances of one integration by name?
      instructions:
      - text: Find configured integration instances matching {query}.
        slots:
          query: requestBody.query
      - text: List configured XSOAR integration instances.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tenant/{prismaId}/integration/channels'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported integration types
      effect: read
      questions:
      - What kinds of external integrations does Prisma Cloud support for my tenant?
      - Which integration channels can I set up?
      instructions:
      - text: List supported integration types for tenant {prismaId}.
        slots:
          prismaId: path.prismaId
      - text: Show the integration channels available to Prisma ID {prismaId}.
        slots:
          prismaId: path.prismaId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tenant/{prismaId}/integration'].get
  update:
    x-apievangelist-phrasing:
      intent: List a tenant's integrations
      effect: read
      questions:
      - Which integrations are configured on my Prisma Cloud tenant?
      - Can I list only the enabled integrations of a particular type?
      instructions:
      - text: List integrations for tenant {prismaId}.
        slots:
          prismaId: path.prismaId
      - text: List enabled {type} integrations for tenant {prismaId}.
        slots:
          type: query.type
          prismaId: path.prismaId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tenant/{prismaId}/integration'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an integration
      effect: write
      questions:
      - How do I connect Prisma Cloud to an external system like a ticketing or messaging tool?
      - What configuration is required to add a new integration?
      instructions:
      - text: Add a {integrationType} integration named {name} to tenant {prismaId} with config {integrationConfig}.
        slots:
          integrationType: requestBody.integrationType
          name: requestBody.name
          prismaId: path.prismaId
          integrationConfig: requestBody.integrationConfig
      - text: Create integration {name} of type {integrationType} on tenant {prismaId} using {integrationConfig}.
        slots:
          name: requestBody.name
          integrationType: requestBody.integrationType
          prismaId: path.prismaId
          integrationConfig: requestBody.integrationConfig
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tenant/{prismaId}/integration/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an integration by ID
      effect: read
      questions:
      - What is the configuration of a specific integration on my tenant?
      - Can I look up one integration's details by its ID?
      instructions:
      - text: Get integration {id} on tenant {prismaId}.
        slots:
          id: path.id
          prismaId: path.prismaId
      - text: Show the configuration of integration {id} for Prisma ID {prismaId}.
        slots:
          id: path.id
          prismaId: path.prismaId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tenant/{prismaId}/integration/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an integration's configuration
      effect: write
      questions:
      - Can I change the name or configuration of an existing integration?
      - What fields must I resend when editing an integration's settings?
      instructions:
      - text: 'Update integration {id} on tenant {prismaId}: name {name}, config {integrationConfig}.'
        slots:
          id: path.id
          prismaId: path.prismaId
          name: requestBody.name
          integrationConfig: requestBody.integrationConfig
      - text: Rename integration {id} on tenant {prismaId} to {name} keeping config {integrationConfig}.
        slots:
          id: path.id
          prismaId: path.prismaId
          name: requestBody.name
          integrationConfig: requestBody.integrationConfig
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tenant/{prismaId}/integration/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an integration
      effect: destructive
      questions:
      - How do I remove an integration I no longer use from my tenant?
      - Is deleting an integration permanent?
      instructions:
      - text: Delete integration {id} from tenant {prismaId}.
        slots:
          id: path.id
          prismaId: path.prismaId
      - text: Remove the integration {id} on Prisma ID {prismaId}.
        slots:
          id: path.id
          prismaId: path.prismaId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tenant/{prismaId}/integration/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable an integration
      effect: write
      questions:
      - Can I temporarily turn off an integration without deleting it?
      - How do I re-enable a disabled integration?
      instructions:
      - text: Set integration {id} on tenant {prismaId} to enabled {enabled}.
        slots:
          id: path.id
          prismaId: path.prismaId
          enabled: requestBody.enabled
      - text: Disable integration {id} for tenant {prismaId}.
        slots:
          id: path.id
          prismaId: path.prismaId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tenant/{prismaId}/integration/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Test an integration configuration
      effect: write
      questions:
      - Can I verify an integration's settings work before saving it?
      - Does the test call check connectivity to the external system?
      instructions:
      - text: Test a {integrationType} integration named {name} on tenant {prismaId} with {integrationConfig}.
        slots:
          integrationType: requestBody.integrationType
          name: requestBody.name
          prismaId: path.prismaId
          integrationConfig: requestBody.integrationConfig
      - text: Run a connectivity test for integration {name} ({integrationType}) on tenant {prismaId} using {integrationConfig}.
        slots:
          name: requestBody.name
          integrationType: requestBody.integrationType
          prismaId: path.prismaId
          integrationConfig: requestBody.integrationConfig
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tenant/{prismaId}/integration/securityhub/regions/{accountId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List Security Hub regions for an AWS account
      effect: read
      questions:
      - In which AWS regions is Security Hub enabled for one of my accounts?
      - Can I check Security Hub region coverage for a single AWS account ID?
      instructions:
      - text: List Security Hub enabled regions for AWS account {accountId} on tenant {prismaId}.
        slots:
          accountId: path.accountId
          prismaId: path.prismaId
      - text: Show where Security Hub is on for account {accountId} under Prisma ID {prismaId}.
        slots:
          accountId: path.accountId
          prismaId: path.prismaId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tenant/{prismaId}/integration/securityhub/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List AWS accounts with Security Hub enabled
      effect: read
      questions:
      - Which of my AWS accounts have Security Hub turned on?
      - What AWS account names and IDs are available for a Security Hub integration?
      instructions:
      - text: List Security Hub enabled AWS accounts for tenant {prismaId}.
        slots:
          prismaId: path.prismaId
      - text: Show AWS accounts with Security Hub for Prisma ID {prismaId}.
        slots:
          prismaId: path.prismaId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/jira-integrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List Jira integrations for posture failures
      effect: read
      questions:
      - Which Jira projects receive tickets when SSPM posture checks fail?
      - What severity mapping do my Jira ticketing integrations use?
      instructions:
      - text: List my Jira integrations for posture check failures.
      - text: Show the configured Jira ticketing integrations and their projects.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/jira-integrations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Jira integration for posture failures
      effect: write
      questions:
      - How do I automatically open Jira tickets when a SaaS posture check fails?
      - Can I map check severities to Jira issue types?
      instructions:
      - text: Create Jira integration {name} for {jira_url} project {project_key} as {email} with token {api_token}.
        slots:
          name: requestBody.name
          jira_url: requestBody.jira_url
          project_key: requestBody.project_key
          email: requestBody.email
          api_token: requestBody.api_token
      - text: Connect Jira at {jira_url} to project {project_key} with issue type {issue_type}, name {name}, user {email}, token {api_token}.
        slots:
          jira_url: requestBody.jira_url
          project_key: requestBody.project_key
          issue_type: requestBody.issue_type
          name: requestBody.name
          email: requestBody.email
          api_token: requestBody.api_token
      method: generated
      generated: '2026-09-26'