# 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 Rule Stacks API
  version: 1.0.0
extends: openapi/palo-alto-networks-rulestacks-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: 6
- target: $.paths['/config/rulestacks'].get
  update:
    x-apievangelist-phrasing:
      intent: List Cloud NGFW rule stacks
      effect: read
      questions:
      - Which rule stacks exist in my Cloud NGFW account?
      - Can I list only rule stacks in a particular scope, like global or local?
      instructions:
      - text: List all rule stacks in the account.
      - text: Show up to {maxresults} rule stacks with scope {scope}.
        slots:
          maxresults: query.maxresults
          scope: query.scope
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/rulestacks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a firewall rule stack
      effect: write
      questions:
      - How do I create a new rule stack to hold security rules and FQDN lists for Cloud NGFW?
      - What do I need to supply to set up a new rule stack container?
      instructions:
      - text: Create rule stack {RuleStackName} with settings {RuleStackEntry}.
        slots:
          RuleStackName: requestBody.RuleStackName
          RuleStackEntry: requestBody.RuleStackEntry
      - text: Set up a new Cloud NGFW rule stack called {RuleStackName} using entry {RuleStackEntry}.
        slots:
          RuleStackName: requestBody.RuleStackName
          RuleStackEntry: requestBody.RuleStackEntry
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/rulestacks/{rulestack}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a rule stack's configuration
      effect: read
      questions:
      - What is configured in a specific rule stack right now?
      - Can I view the uncommitted candidate configuration of a rule stack?
      instructions:
      - text: Get the configuration of rule stack {rulestack}.
        slots:
          rulestack: path.rulestack
      - text: 'Show the candidate (uncommitted) config of rule stack {rulestack}: candidate={candidate}.'
        slots:
          rulestack: path.rulestack
          candidate: query.candidate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/rulestacks/{rulestack}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a rule stack's configuration
      effect: write
      questions:
      - How do I stage changes to an existing rule stack before committing them?
      - Are updates to a rule stack live immediately or held until commit?
      instructions:
      - text: Update rule stack {rulestack} with name {RuleStackName} and entry {RuleStackEntry}.
        slots:
          rulestack: path.rulestack
          RuleStackName: requestBody.RuleStackName
          RuleStackEntry: requestBody.RuleStackEntry
      - text: Stage a new configuration {RuleStackEntry} on rule stack {rulestack} ({RuleStackName}).
        slots:
          RuleStackEntry: requestBody.RuleStackEntry
          rulestack: path.rulestack
          RuleStackName: requestBody.RuleStackName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/rulestacks/{rulestack}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a rule stack
      effect: destructive
      questions:
      - How do I delete a rule stack I no longer need?
      - Can I delete a rule stack that is still attached to a Cloud NGFW firewall?
      instructions:
      - text: Delete rule stack {rulestack}.
        slots:
          rulestack: path.rulestack
      - text: Remove the unused rule stack {rulestack} from the account.
        slots:
          rulestack: path.rulestack
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/rulestacks/{rulestack}/commit'].post
  update:
    x-apievangelist-phrasing:
      intent: Commit a rule stack to running config
      effect: write
      questions:
      - How do I push my staged rule stack changes out to the active firewalls?
      - What makes candidate rule stack edits take effect on Cloud NGFW instances?
      instructions:
      - text: Commit rule stack {rulestack}.
        slots:
          rulestack: path.rulestack
      - text: Apply the staged changes in rule stack {rulestack} to its firewalls.
        slots:
          rulestack: path.rulestack
      method: generated
      generated: '2026-09-26'