Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Manage Security Rules API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-managesecurityrules-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}/rulelists/{rulelistname}'].get
$.paths['/v1/config/rulestacks/{rulestackname}/rulelists/{rulelistname}'].post
$.paths['/v1/config/rulestacks/{rulestackname}/rulelists/{rulelistname}/priorities/{priority}'].get
$.paths['/v1/config/rulestacks/{rulestackname}/rulelists/{rulelistname}/priorities/{priority}'].put
$.paths['/v1/config/rulestacks/{rulestackname}/rulelists/{rulelistname}/priorities/{priority}'].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 Security Rules API
  version: 1.0.0
extends: openapi/palo-alto-networks-managesecurityrules-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}/rulelists/{rulelistname}'].get
  update:
    x-apievangelist-phrasing:
      intent: List security rules in a rulestack
      effect: read
      questions:
      - What security rules are in my Cloud NGFW rulestack, in priority order?
      - Can I see only the uncommitted or running rules in a rule list?
      instructions:
      - text: List security rules in rulestack {rulestackname}, rule list {rulelistname}.
        slots:
          rulestackname: path.rulestackname
          rulelistname: path.rulelistname
      - text: Show up to {maxresults} rules from {rulelistname} in rulestack {rulestackname}.
        slots:
          maxresults: query.maxresults
          rulelistname: path.rulelistname
          rulestackname: path.rulestackname
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/rulestacks/{rulestackname}/rulelists/{rulelistname}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a security rule in a rulestack
      effect: write
      questions:
      - How do I add a new security rule to a Cloud NGFW rulestack?
      - Can I choose the priority of a new rule when I create it?
      instructions:
      - text: Create a rule at priority {Priority} in {rulelistname} of rulestack {rulestackname} with entry {RuleEntry}.
        slots:
          Priority: requestBody.Priority
          rulelistname: path.rulelistname
          rulestackname: path.rulestackname
          RuleEntry: requestBody.RuleEntry
      - text: Add security rule {RuleEntry} to rulestack {rulestackname}, list {rulelistname}, priority {Priority}.
        slots:
          RuleEntry: requestBody.RuleEntry
          rulestackname: path.rulestackname
          rulelistname: path.rulelistname
          Priority: requestBody.Priority
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/rulestacks/{rulestackname}/rulelists/{rulelistname}/priorities/{priority}'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe a security rule at a priority
      effect: read
      questions:
      - What does the rule at a specific priority in my rulestack do?
      - Can I compare the candidate and running version of one security rule?
      instructions:
      - text: Describe the rule at priority {priority} in {rulelistname} of rulestack {rulestackname}.
        slots:
          priority: path.priority
          rulelistname: path.rulelistname
          rulestackname: path.rulestackname
      - text: Show the running version of rule {priority} in rulestack {rulestackname}, list {rulelistname}.
        slots:
          priority: path.priority
          rulestackname: path.rulestackname
          rulelistname: path.rulelistname
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/rulestacks/{rulestackname}/rulelists/{rulelistname}/priorities/{priority}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a security rule at a priority
      effect: write
      questions:
      - How do I change an existing security rule in a Cloud NGFW rulestack?
      - Can I edit the rule at a given priority without recreating it?
      instructions:
      - text: Update the rule at priority {priority} in {rulelistname} of rulestack {rulestackname} to {RuleEntry}.
        slots:
          priority: path.priority
          rulelistname: path.rulelistname
          rulestackname: path.rulestackname
          RuleEntry: requestBody.RuleEntry
      - text: Replace security rule {priority} in rulestack {rulestackname}, list {rulelistname}, with {RuleEntry}.
        slots:
          priority: path.priority
          rulestackname: path.rulestackname
          rulelistname: path.rulelistname
          RuleEntry: requestBody.RuleEntry
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/rulestacks/{rulestackname}/rulelists/{rulelistname}/priorities/{priority}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a security rule at a priority
      effect: destructive
      questions:
      - How do I remove a security rule from a Cloud NGFW rulestack?
      - Can I delete a rule by its priority number?
      instructions:
      - text: Delete the rule at priority {priority} in {rulelistname} of rulestack {rulestackname}.
        slots:
          priority: path.priority
          rulelistname: path.rulelistname
          rulestackname: path.rulestackname
      - text: Remove security rule {priority} from rulestack {rulestackname}, list {rulelistname}.
        slots:
          priority: path.priority
          rulestackname: path.rulestackname
          rulelistname: path.rulelistname
      method: generated
      generated: '2026-09-26'