Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for v2 OCR Enablement API

3 actions 3 updates phrasing extends openapi/palo-alto-networks-ocr-enablement-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 3

$.info

$.paths['/v2/api/ocr'].get

$.paths['/v2/api/ocr'].put

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 v2 OCR Enablement API
  version: 1.0.0
extends: openapi/palo-alto-networks-ocr-enablement-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: 2
- target: $.paths['/v2/api/ocr'].get
  update:
    x-apievangelist-phrasing:
      intent: Get OCR enablement settings
      effect: read
      questions:
      - Is OCR turned on for DLP scanning of images?
      - Can I check OCR enablement for one target service only?
      instructions:
      - text: Show the OCR enablement settings.
      - text: Get OCR enablement for service {target-service-name}.
        slots:
          target-service-name: query.target-service-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/ocr'].put
  update:
    x-apievangelist-phrasing:
      intent: Turn OCR on or off for a service
      effect: write
      questions:
      - How do I enable OCR for a specific service?
      - Can I disable image text extraction for one service?
      instructions:
      - text: Set OCR enablement for {target_service_name} to {ocr_enablement}.
        slots:
          target_service_name: requestBody.target_service_name
          ocr_enablement: requestBody.ocr_enablement
      - text: Turn OCR off for {target_service_name} by setting enablement to {ocr_enablement}.
        slots:
          target_service_name: requestBody.target_service_name
          ocr_enablement: requestBody.ocr_enablement
      method: generated
      generated: '2026-09-26'