Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Security Services Anti-Spyware Signatures API

10 actions 10 updates phrasing extends openapi/palo-alto-networks-anti-spyware-signatures-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 10

$.info
$.paths['/anti-spyware-signatures'].get
$.paths['/anti-spyware-signatures'].post
$.paths['/anti-spyware-signatures/{id}'].get
$.paths['/anti-spyware-signatures/{id}'].put
$.paths['/anti-spyware-signatures/{id}'].delete
$.paths['/sse/config/v1/anti-spyware-signatures'].get
$.paths['/sse/config/v1/anti-spyware-signatures'].post
$.paths['/sse/config/v1/anti-spyware-signatures/{id}'].put
$.paths['/sse/config/v1/anti-spyware-signatures/{id}'].delete

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 Security Services Anti-Spyware Signatures API
  version: 1.0.0
extends: openapi/palo-alto-networks-anti-spyware-signatures-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/anti-spyware-signatures'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom anti-spyware signatures
      effect: read
      questions:
      - Which custom anti-spyware signatures are defined in a folder?
      - Can I list spyware signatures scoped to a snippet or device?
      instructions:
      - text: List anti-spyware signatures in folder {folder}.
        slots:
          folder: query.folder
      - text: Show the first {limit} anti-spyware signatures on device {device}.
        slots:
          limit: query.limit
          device: query.device
      method: generated
      generated: '2026-09-26'
- target: $.paths['/anti-spyware-signatures'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom anti-spyware signature
      effect: write
      questions:
      - How do I add my own spyware threat signature with a threat ID?
      - Can a custom spyware signature reference a CVE and set a default action?
      instructions:
      - text: Create anti-spyware signature {threatname} with threat ID {threat_id}.
        slots:
          threatname: requestBody.threatname
          threat_id: requestBody.threat_id
      - text: Add spyware signature {threatname} ({threat_id}) at severity {severity} for CVE {cve}.
        slots:
          threatname: requestBody.threatname
          threat_id: requestBody.threat_id
          severity: requestBody.severity
          cve: requestBody.cve
      method: generated
      generated: '2026-09-26'
- target: $.paths['/anti-spyware-signatures/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an anti-spyware signature
      effect: read
      questions:
      - What severity and default action does one anti-spyware signature have?
      - Can I read a spyware signature's pattern by its ID?
      instructions:
      - text: Get anti-spyware signature {id}.
        slots:
          id: path.id
      - text: Show the pattern and action of spyware signature {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/anti-spyware-signatures/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an anti-spyware signature
      effect: write
      questions:
      - Can I change the default action on an existing spyware signature?
      - How do I raise the severity of a custom anti-spyware signature?
      instructions:
      - text: Update anti-spyware signature {id} ({threatname}, threat ID {threat_id}) to severity {severity}.
        slots:
          id: path.id
          threatname: requestBody.threatname
          threat_id: requestBody.threat_id
          severity: requestBody.severity
      - text: Set default action {default_action} on spyware signature {id} named {threatname}, threat ID {threat_id}.
        slots:
          default_action: requestBody.default_action
          id: path.id
          threatname: requestBody.threatname
          threat_id: requestBody.threat_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/anti-spyware-signatures/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an anti-spyware signature
      effect: destructive
      questions:
      - How do I remove a custom anti-spyware signature?
      - Is a deleted spyware signature recoverable?
      instructions:
      - text: Delete anti-spyware signature {id}.
        slots:
          id: path.id
      - text: Remove the custom spyware signature {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/anti-spyware-signatures'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom anti-spyware signatures
      effect: read
      questions:
      - Which custom anti-spyware signatures are in a Prisma Access folder?
      - Can I find an anti-spyware signature by name?
      instructions:
      - text: List the SSE config anti-spyware signatures in folder {folder}.
        slots:
          folder: query.folder
      - text: Find anti-spyware signature {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/anti-spyware-signatures'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom anti-spyware signature
      effect: write
      questions:
      - How do I add my own anti-spyware signature for a new threat?
      - Can a custom spyware signature reference a CVE and set a severity?
      instructions:
      - text: Create anti-spyware signature {threatname} with threat ID {threat_id} in folder {folder}.
        slots:
          threatname: requestBody.threatname
          threat_id: requestBody.threat_id
          folder: query.folder
      - text: Add spyware signature {threatname} (ID {threat_id}) in {folder} with severity {severity} and CVE {cve}.
        slots:
          threatname: requestBody.threatname
          threat_id: requestBody.threat_id
          folder: query.folder
          severity: requestBody.severity
          cve: requestBody.cve
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/anti-spyware-signatures/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a custom anti-spyware signature
      effect: write
      questions:
      - Can I edit a custom spyware signature through the SSE config v1 endpoint?
      - Is it possible to update the severity of a custom anti-spyware signature?
      instructions:
      - text: Set default action {default_action} on anti-spyware signature {id}.
        slots:
          default_action: requestBody.default_action
          id: path.id
      - text: Update signature {id} to threat name {threatname}, threat ID {threat_id}.
        slots:
          id: path.id
          threatname: requestBody.threatname
          threat_id: requestBody.threat_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/anti-spyware-signatures/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom anti-spyware signature
      effect: destructive
      questions:
      - How do I delete a spyware signature through the SSE config v1 API?
      - Will deleting a spyware signature stop detection of that threat?
      instructions:
      - text: Delete SSE config anti-spyware signature {id}.
        slots:
          id: path.id
      - text: Remove the obsolete spyware signature {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'