Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Advanced DNS Security Resolver Configuration Internal…

6 actions 6 updates phrasing extends openapi/palo-alto-networks-internal-domains-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['/adns-resolver/v1/internal-domains'].get

$.paths['/adns-resolver/v1/internal-domains'].post

$.paths['/adns-resolver/v1/internal-domains/{internal-domain-id}'].get

$.paths['/adns-resolver/v1/internal-domains/{internal-domain-id}'].put

$.paths['/adns-resolver/v1/internal-domains/{internal-domain-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 Advanced DNS Security Resolver Configuration Internal…
  version: 1.0.0
extends: openapi/palo-alto-networks-internal-domains-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['/adns-resolver/v1/internal-domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List internal domains
      effect: read
      questions:
      - Which internal domains are configured for the DNS resolver?
      - Can I see the system default internal domains instead of my custom ones?
      - Is there a way to search and sort internal domains?
      instructions:
      - text: List my custom internal domains.
      - text: List internal domains of type {type}.
        slots:
          type: query.type
      - text: Search internal domains for {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adns-resolver/v1/internal-domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a custom internal domain
      effect: write
      questions:
      - How do I add a custom internal domain?
      - Can I create default internal domains too, or only custom ones?
      instructions:
      - text: Create custom internal domain {domain}.
        slots:
          domain: requestBody.domain
      - text: Add internal domain {domain} described as {description}.
        slots:
          domain: requestBody.domain
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adns-resolver/v1/internal-domains/{internal-domain-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an internal domain
      effect: read
      questions:
      - Can I look up one internal domain by ID?
      - What details are stored for a single internal domain?
      instructions:
      - text: Get internal domain {internal_domain_id}.
        slots:
          internal_domain_id: path.internal-domain-id
      - text: Show internal domain entry {internal_domain_id}.
        slots:
          internal_domain_id: path.internal-domain-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adns-resolver/v1/internal-domains/{internal-domain-id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom internal domain
      effect: write
      questions:
      - Can I change the domain name on a custom internal domain entry?
      - Are default internal domains editable?
      instructions:
      - text: Change internal domain {internal_domain_id} to {domain}.
        slots:
          internal_domain_id: path.internal-domain-id
          domain: requestBody.domain
      - text: Update the description of internal domain {internal_domain_id} ({domain}) to {description}.
        slots:
          internal_domain_id: path.internal-domain-id
          domain: requestBody.domain
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adns-resolver/v1/internal-domains/{internal-domain-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom internal domain
      effect: destructive
      questions:
      - How do I remove a custom internal domain?
      - Can a default internal domain be deleted?
      instructions:
      - text: Delete internal domain {internal_domain_id}.
        slots:
          internal_domain_id: path.internal-domain-id
      - text: Remove custom internal domain {internal_domain_id}.
        slots:
          internal_domain_id: path.internal-domain-id
      method: generated
      generated: '2026-09-26'