Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Advanced DNS Security Resolver Configuration Custom FQDN API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-custom-fqdn-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/custom-fqdns'].get

$.paths['/adns-resolver/v1/custom-fqdns'].post

$.paths['/adns-resolver/v1/custom-fqdns/{custom-fqdn-id}'].get

$.paths['/adns-resolver/v1/custom-fqdns/{custom-fqdn-id}'].put

$.paths['/adns-resolver/v1/custom-fqdns/{custom-fqdn-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 Custom FQDN API
  version: 1.0.0
extends: openapi/palo-alto-networks-custom-fqdn-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/custom-fqdns'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom FQDN groups
      effect: read
      questions:
      - Which custom FQDN groups are defined for the DNS resolver?
      - Can I search and sort my custom FQDN groups?
      instructions:
      - text: List my custom FQDN groups.
      - text: Search custom FQDN groups for {search} sorted by {sort_by} {sort_order}.
        slots:
          search: query.search
          sort_by: query.sort_by
          sort_order: query.sort_order
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adns-resolver/v1/custom-fqdns'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom FQDN group
      effect: write
      questions:
      - How do I create a custom FQDN group of internal domains for the resolver?
      - Can I describe a new custom FQDN group when I create it?
      instructions:
      - text: Create custom FQDN group {name} containing {fqdns}.
        slots:
          name: requestBody.name
          fqdns: requestBody.fqdns
      - text: Add a custom FQDN group {name} for {fqdns} described as {description}.
        slots:
          name: requestBody.name
          fqdns: requestBody.fqdns
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adns-resolver/v1/custom-fqdns/{custom-fqdn-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom FQDN group
      effect: read
      questions:
      - Which domains are in a specific custom FQDN group?
      - Can I page through the FQDNs inside one large group?
      instructions:
      - text: Get custom FQDN group {custom-fqdn-id}.
        slots:
          custom-fqdn-id: path.custom-fqdn-id
      - text: Show {fqdn-limit} FQDNs from group {custom-fqdn-id} starting at {fqdn-offset}.
        slots:
          custom-fqdn-id: path.custom-fqdn-id
          fqdn-limit: query.fqdn-limit
          fqdn-offset: query.fqdn-offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adns-resolver/v1/custom-fqdns/{custom-fqdn-id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom FQDN group
      effect: write
      questions:
      - How do I change the domain list of an existing custom FQDN group?
      - Can I rename a custom FQDN group?
      instructions:
      - text: Update custom FQDN group {custom-fqdn-id} named {name} to contain {fqdns}.
        slots:
          custom-fqdn-id: path.custom-fqdn-id
          name: requestBody.name
          fqdns: requestBody.fqdns
      - text: Change the description of custom FQDN group {custom-fqdn-id} ({name}, {fqdns}) to {description}.
        slots:
          custom-fqdn-id: path.custom-fqdn-id
          name: requestBody.name
          fqdns: requestBody.fqdns
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adns-resolver/v1/custom-fqdns/{custom-fqdn-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom FQDN group
      effect: destructive
      questions:
      - Can I remove a custom FQDN group from the resolver?
      - What do I need to delete a custom FQDN group?
      instructions:
      - text: Delete custom FQDN group {custom-fqdn-id}.
        slots:
          custom-fqdn-id: path.custom-fqdn-id
      - text: Remove custom FQDN group {custom-fqdn-id} from the resolver.
        slots:
          custom-fqdn-id: path.custom-fqdn-id
      method: generated
      generated: '2026-09-26'