Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Custom Compliance API

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

$.info

$.paths['/api/v34.03/custom-compliance'].get

$.paths['/api/v34.03/custom-compliance'].put

$.paths['/api/v34.03/custom-compliance/{id}'].delete

$.paths['/api/v34.04/custom-compliance'].get

$.paths['/api/v34.04/custom-compliance'].put

$.paths['/api/v34.04/custom-compliance/{id}'].delete

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 Palo Alto Networks Custom Compliance API
  version: 1.0.0
extends: openapi/palo-alto-networks-custom-compliance-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: 6
- target: $.paths['/api/v34.03/custom-compliance'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom compliance checks (v34.03)
      effect: read
      questions:
      - What custom compliance checks are defined when I call the v34.03 API version?
      - Can I list custom compliance check scripts using the older v34.03 path?
      instructions:
      - text: List custom compliance checks via the v34.03 API.
      - text: Show all v34.03 custom compliance check scripts and severities.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/custom-compliance'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom compliance check (v34.03)
      effect: write
      questions:
      - How do I update a custom compliance check's script through the v34.03 API?
      - Can I disable a custom compliance rule using the v34.03 endpoint?
      instructions:
      - text: Using v34.03, update custom compliance check {name} with script {script}.
        slots:
          name: requestBody.name
          script: requestBody.script
      - text: Via the v34.03 API, set custom check {name} disabled to {disabled}.
        slots:
          name: requestBody.name
          disabled: requestBody.disabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/custom-compliance/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom compliance check (v34.03)
      effect: destructive
      questions:
      - Which v34.03 call permanently removes a custom compliance check?
      - Can I remove a custom check by ID on the older v34.03 path?
      instructions:
      - text: Delete custom compliance check {id} via v34.03.
        slots:
          id: path.id
      - text: Remove v34.03 custom check {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/custom-compliance'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom compliance checks (v34.04)
      effect: read
      questions:
      - Which custom compliance checks exist in the current v34.04 API?
      - Can I see each custom check's title and severity with the v34.04 call?
      instructions:
      - text: List custom compliance checks via the v34.04 API.
      - text: Show the v34.04 custom compliance checks with their titles.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/custom-compliance'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom compliance check (v34.04)
      effect: write
      questions:
      - How do I rename a custom compliance check using the v34.04 API?
      - Can I change a custom check's severity through the v34.04 endpoint?
      instructions:
      - text: Using v34.04, rename custom check {previousName} to {name}.
        slots:
          previousName: requestBody.previousName
          name: requestBody.name
      - text: Via v34.04, set severity of custom compliance check {name} to {severity}.
        slots:
          name: requestBody.name
          severity: requestBody.severity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/custom-compliance/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom compliance check (v34.04)
      effect: destructive
      questions:
      - Is it possible to permanently remove one of my custom checks through the newer v34.04 path?
      - Can I remove a custom check by its ID in v34.04?
      instructions:
      - text: Delete custom compliance check {id} via v34.04.
        slots:
          id: path.id
      - text: Remove v34.04 custom check {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'