Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Network Services DNS Proxies API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-dns-proxies-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 6

$.info

$.paths['/dns-proxies'].get

$.paths['/dns-proxies'].post

$.paths['/dns-proxies/{id}'].get

$.paths['/dns-proxies/{id}'].put

$.paths['/dns-proxies/{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 Network Services DNS Proxies API
  version: 1.0.0
extends: openapi/palo-alto-networks-dns-proxies-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: 5
- target: $.paths['/dns-proxies'].get
  update:
    x-apievangelist-phrasing:
      intent: List DNS proxies
      effect: read
      questions:
      - Which DNS proxies are configured in a given folder?
      - Can I look up a DNS proxy by name on a specific device?
      instructions:
      - text: List the DNS proxies in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the DNS proxy named {name} on device {device}.
        slots:
          name: query.name
          device: query.device
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dns-proxies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a DNS proxy
      effect: write
      questions:
      - How do I set up a DNS proxy on my firewall interfaces?
      - Can a new DNS proxy include static entries and caching?
      instructions:
      - text: Create DNS proxy {name} with default servers {default}.
        slots:
          name: requestBody.name
          default: requestBody.default
      - text: Add DNS proxy {name} using default {default} on interfaces {interface}.
        slots:
          name: requestBody.name
          default: requestBody.default
          interface: requestBody.interface
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dns-proxies/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a DNS proxy
      effect: read
      questions:
      - What domain server rules does one DNS proxy use?
      - Where can I see a DNS proxy's full settings by its UUID?
      instructions:
      - text: Get DNS proxy {id}.
        slots:
          id: path.id
      - text: Show the settings of DNS proxy {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dns-proxies/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a DNS proxy
      effect: write
      questions:
      - How do I change the domain server rules on an existing DNS proxy?
      - Can I disable an existing DNS proxy without deleting it?
      instructions:
      - text: Update DNS proxy {id} with name {name} and default {default}.
        slots:
          id: path.id
          name: requestBody.name
          default: requestBody.default
      - text: Set enabled to {enabled} on existing DNS proxy {id}.
        slots:
          id: path.id
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dns-proxies/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a DNS proxy
      effect: destructive
      questions:
      - Can I remove a DNS proxy I no longer use?
      - Is deleting a DNS proxy reversible?
      instructions:
      - text: Delete DNS proxy {id}.
        slots:
          id: path.id
      - text: Remove the DNS proxy with UUID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'