Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Manage Prefix Lists API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-manageprefixlists-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['/v1/config/rulestacks/{rulestackname}/prefixlists'].get
$.paths['/v1/config/rulestacks/{rulestackname}/prefixlists'].post
$.paths['/v1/config/rulestacks/{rulestackname}/prefixlists/{name}'].get
$.paths['/v1/config/rulestacks/{rulestackname}/prefixlists/{name}'].put
$.paths['/v1/config/rulestacks/{rulestackname}/prefixlists/{name}'].delete

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Manage Prefix Lists API
  version: 1.0.0
extends: openapi/palo-alto-networks-manageprefixlists-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['/v1/config/rulestacks/{rulestackname}/prefixlists'].get
  update:
    x-apievangelist-phrasing:
      intent: List prefix lists in a rulestack
      effect: read
      questions:
      - Which prefix lists are defined on a Cloud NGFW rulestack?
      - Can I see only the uncommitted or running prefix lists?
      instructions:
      - text: List prefix lists in rulestack {rulestack}.
        slots:
          rulestack: path.rulestackname
      - text: List running prefix lists in rulestack {rulestack}, up to {maxresults}.
        slots:
          rulestack: path.rulestackname
          maxresults: query.maxresults
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/rulestacks/{rulestackname}/prefixlists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a prefix list in a rulestack
      effect: write
      questions:
      - How do I add a set of CIDR prefixes to a rulestack for rules to reference?
      - Can I leave an audit comment when creating a prefix list?
      instructions:
      - text: Create prefix list {name} with prefixes {prefixes} in rulestack {rulestack}.
        slots:
          name: requestBody.Name
          prefixes: requestBody.PrefixList
          rulestack: path.rulestackname
      - text: Add prefix list {name} to rulestack {rulestack} with prefixes {prefixes} and comment {comment}.
        slots:
          name: requestBody.Name
          rulestack: path.rulestackname
          prefixes: requestBody.PrefixList
          comment: requestBody.AuditComment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/rulestacks/{rulestackname}/prefixlists/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe one prefix list
      effect: read
      questions:
      - What CIDRs are in a specific prefix list on my rulestack?
      - Can I describe the candidate version of one prefix list?
      instructions:
      - text: Describe prefix list {name} in rulestack {rulestack}.
        slots:
          name: path.name
          rulestack: path.rulestackname
      - text: Show the prefixes in list {name} on rulestack {rulestack}.
        slots:
          name: path.name
          rulestack: path.rulestackname
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/rulestacks/{rulestackname}/prefixlists/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a prefix list's prefixes
      effect: write
      questions:
      - Can I replace the CIDRs in an existing prefix list?
      - Do I need an update token to change a prefix list?
      instructions:
      - text: Update prefix list {name} in rulestack {rulestack} to {prefixes}.
        slots:
          name: path.name
          rulestack: path.rulestackname
          prefixes: requestBody.PrefixList
      - text: Replace prefixes on list {name} in {rulestack} with {prefixes} using token {token}.
        slots:
          name: path.name
          rulestack: path.rulestackname
          prefixes: requestBody.PrefixList
          token: requestBody.UpdateToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/rulestacks/{rulestackname}/prefixlists/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a prefix list from a rulestack
      effect: destructive
      questions:
      - How do I remove a prefix list from a rulestack?
      - Is a prefix list deletion permanent once the rulestack is committed?
      instructions:
      - text: Delete prefix list {name} from rulestack {rulestack}.
        slots:
          name: path.name
          rulestack: path.rulestackname
      - text: Remove the prefix list {name} on {rulestack}.
        slots:
          name: path.name
          rulestack: path.rulestackname
      method: generated
      generated: '2026-09-26'