Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Cloud NGFW for AWS REST FQDN Lists API

3 actions 3 updates phrasing extends openapi/palo-alto-networks-fqdnlists-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['/config/rulestacks/{rulestack}/fqdnlists'].get

$.paths['/config/rulestacks/{rulestack}/fqdnlists'].post

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 Cloud NGFW for AWS REST FQDN Lists API
  version: 1.0.0
extends: openapi/palo-alto-networks-fqdnlists-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['/config/rulestacks/{rulestack}/fqdnlists'].get
  update:
    x-apievangelist-phrasing:
      intent: List FQDN lists in a rule stack
      effect: read
      questions:
      - Which FQDN lists of domain names exist in my rule stack?
      - Can I page through a rule stack's FQDN lists with a next token?
      instructions:
      - text: List FQDN lists in rule stack {rulestack}.
        slots:
          rulestack: path.rulestack
      - text: List up to {maxresults} FQDN lists in {rulestack}.
        slots:
          maxresults: query.maxresults
          rulestack: path.rulestack
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/rulestacks/{rulestack}/fqdnlists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an FQDN list in a rule stack
      effect: write
      questions:
      - How do I create a list of domains to use as a security rule destination?
      - Can I add several domain entries when creating an FQDN list?
      instructions:
      - text: Create FQDN list {FqdnListName} in rule stack {rulestack} with entries {FqdnListEntry}.
        slots:
          FqdnListName: requestBody.FqdnListName
          rulestack: path.rulestack
          FqdnListEntry: requestBody.FqdnListEntry
      - text: Add domains {FqdnListEntry} as a new FQDN list named {FqdnListName} in {rulestack}.
        slots:
          FqdnListEntry: requestBody.FqdnListEntry
          FqdnListName: requestBody.FqdnListName
          rulestack: path.rulestack
      method: generated
      generated: '2026-09-26'