Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SSPM Management JIRA API

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

$.info

$.paths['/sspm/api/v1/integration/integrations/{integration_id}/{integration_type}/issue/{key}'].get

$.paths['/sspm/api/v1/integration/integrations/{integration_id}/{integration_type}/project/{key}'].get

$.paths['/sspm/api/v1/integration/integrations/{integration_id}/{integration_type}/projects'].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 SSPM Management JIRA API
  version: 1.0.0
extends: openapi/palo-alto-networks-jira-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: 3
- target: $.paths['/sspm/api/v1/integration/integrations/{integration_id}/{integration_type}/issue/{key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Jira issue from an SSPM integration
      effect: read
      questions:
      - Can I look up the details of a Jira ticket created from SSPM?
      - What does an onboarded Jira issue look like by key?
      instructions:
      - text: Get Jira issue {key} from integration {integration_id} of type {integration_type}.
        slots:
          key: path.key
          integration_id: path.integration_id
          integration_type: path.integration_type
      - text: Show Jira ticket {key} from SSPM integration {integration_id} ({integration_type}) in region {x-panw-region}.
        slots:
          key: path.key
          integration_id: path.integration_id
          integration_type: path.integration_type
          x-panw-region: header.x-panw-region
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sspm/api/v1/integration/integrations/{integration_id}/{integration_type}/project/{key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Jira project from an SSPM integration
      effect: read
      questions:
      - What are the details of a Jira project connected to SSPM?
      - Can I fetch one onboarded Jira project by key?
      instructions:
      - text: Get Jira project {key} from integration {integration_id} ({integration_type}).
        slots:
          key: path.key
          integration_id: path.integration_id
          integration_type: path.integration_type
      - text: Show details of onboarded Jira project {key} in SSPM integration {integration_id} of type {integration_type}.
        slots:
          key: path.key
          integration_id: path.integration_id
          integration_type: path.integration_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sspm/api/v1/integration/integrations/{integration_id}/{integration_type}/projects'].get
  update:
    x-apievangelist-phrasing:
      intent: List Jira projects in an SSPM integration
      effect: read
      questions:
      - Which Jira projects are onboarded to my SSPM ticketing integration?
      - Can I list projects for a Jira integration in a specific region?
      instructions:
      - text: List Jira projects for integration {integration_id} of type {integration_type}.
        slots:
          integration_id: path.integration_id
          integration_type: path.integration_type
      - text: Show the Jira project list for integration {integration_id} ({integration_type}) in region {x-panw-region}.
        slots:
          integration_id: path.integration_id
          integration_type: path.integration_type
          x-panw-region: header.x-panw-region
      method: generated
      generated: '2026-09-26'