# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Manage FQDN List API
  version: 1.0.0
extends: openapi/palo-alto-networks-fqdnlist-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/v1/config/rulestacks/{rulestackname}/fqdnlists'].get
  update:
    x-apievangelist-phrasing:
      intent: List FQDN lists in a rulestack
      effect: read
      questions:
      - Which FQDN lists does a Cloud NGFW rulestack contain?
      - Can I see only the running or candidate versions of a rulestack's FQDN lists?
      instructions:
      - text: List the FQDN lists in rulestack {rulestackname}, up to {maxresults} results.
        slots:
          rulestackname: path.rulestackname
          maxresults: query.maxresults
      - text: List the next page of FQDN lists in rulestack {rulestackname} using token {nexttoken}.
        slots:
          rulestackname: path.rulestackname
          nexttoken: query.nexttoken
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/config/rulestacks/{rulestackname}/fqdnlists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an FQDN list in a rulestack
      effect: write
      questions:
      - How do I add a list of domain names to a Cloud NGFW rulestack?
      - Can I attach an audit comment when creating an FQDN list?
      instructions:
      - text: Create FQDN list {Name} in rulestack {rulestackname} with domains {FqdnList}.
        slots:
          Name: requestBody.Name
          rulestackname: path.rulestackname
          FqdnList: requestBody.FqdnList
      - text: Add FQDN list {Name} to {rulestackname} containing {FqdnList} with audit comment {AuditComment}.
        slots:
          Name: requestBody.Name
          rulestackname: path.rulestackname
          FqdnList: requestBody.FqdnList
          AuditComment: requestBody.AuditComment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/rulestacks/{rulestackname}/fqdnlists/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an FQDN list from a rulestack
      effect: read
      questions:
      - What domains are in a specific FQDN list on my rulestack?
      - Can I compare the running and candidate versions of one FQDN list?
      instructions:
      - text: Get FQDN list {name} from rulestack {rulestackname}.
        slots:
          name: path.name
          rulestackname: path.rulestackname
      - text: Show the running version of FQDN list {name} in {rulestackname}.
        slots:
          name: path.name
          rulestackname: path.rulestackname
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/rulestacks/{rulestackname}/fqdnlists/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an FQDN list in a rulestack
      effect: write
      questions:
      - How do I change the domains in an existing FQDN list?
      - Can I update an FQDN list's description with an audit comment?
      instructions:
      - text: Update FQDN list {name} in {rulestackname} to contain {FqdnList}.
        slots:
          name: path.name
          rulestackname: path.rulestackname
          FqdnList: requestBody.FqdnList
      - text: Replace domains in FQDN list {name} on {rulestackname} with {FqdnList}, description {Description}.
        slots:
          name: path.name
          rulestackname: path.rulestackname
          FqdnList: requestBody.FqdnList
          Description: requestBody.Description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/rulestacks/{rulestackname}/fqdnlists/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an FQDN list from a rulestack
      effect: destructive
      questions:
      - How do I delete an FQDN list from a rulestack?
      - Is removing an FQDN list done by rulestack and list name?
      instructions:
      - text: Delete FQDN list {name} from rulestack {rulestackname}.
        slots:
          name: path.name
          rulestackname: path.rulestackname
      - text: Remove the {name} FQDN list in {rulestackname}.
        slots:
          name: path.name
          rulestackname: path.rulestackname
      method: generated
      generated: '2026-09-26'