Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Manage Rulestacks API

10 actions 10 updates phrasing extends openapi/palo-alto-networks-managerulestacks-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 10

$.info
$.paths['/v1/config/rulestacks'].get
$.paths['/v1/config/rulestacks'].post
$.paths['/v1/config/rulestacks/{rulestackname}'].get
$.paths['/v1/config/rulestacks/{rulestackname}'].put
$.paths['/v1/config/rulestacks/{rulestackname}'].delete
$.paths['/v1/config/rulestacks/{rulestackname}/commit'].get
$.paths['/v1/config/rulestacks/{rulestackname}/commit'].post
$.paths['/v1/config/rulestacks/{rulestackname}/revert'].post
$.paths['/v1/config/rulestacks/{rulestackname}/validate'].post

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 Rulestacks API
  version: 1.0.0
extends: openapi/palo-alto-networks-managerulestacks-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: 9
- target: $.paths['/v1/config/rulestacks'].get
  update:
    x-apievangelist-phrasing:
      intent: List rulestacks
      effect: read
      questions:
      - Which rulestacks exist for my Cloud NGFW, global and local?
      - Can I list rulestacks by tag key and value?
      instructions:
      - text: List rulestacks with scope {Scope}.
        slots:
          Scope: requestBody.Scope
      - text: Find rulestacks tagged {TagKey}={TagValue}.
        slots:
          TagKey: requestBody.TagKey
          TagValue: requestBody.TagValue
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/rulestacks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a rulestack
      effect: write
      questions:
      - How do I create a new global or local rulestack for Cloud NGFW?
      - Which role permissions do I need to create a global rulestack?
      instructions:
      - text: Create rulestack {RuleStackName}.
        slots:
          RuleStackName: requestBody.RuleStackName
      - text: Create rulestack {RuleStackName} with entry settings {RuleStackEntry}.
        slots:
          RuleStackName: requestBody.RuleStackName
          RuleStackEntry: requestBody.RuleStackEntry
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/rulestacks/{rulestackname}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a rulestack's configuration
      effect: read
      questions:
      - What is configured in a particular rulestack?
      - Can I see the running version of a rulestack instead of the candidate?
      instructions:
      - text: Show the configuration of rulestack {rulestackname}.
        slots:
          rulestackname: path.rulestackname
      - text: Get the running config of rulestack {rulestackname}.
        slots:
          rulestackname: path.rulestackname
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/rulestacks/{rulestackname}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a rulestack's configuration
      effect: write
      questions:
      - Can I change a rulestack's settings after it is created?
      - Is it possible to switch a rulestack from local to global scope?
      instructions:
      - text: Update rulestack {rulestackname} with {RuleStackEntry}.
        slots:
          rulestackname: path.rulestackname
          RuleStackEntry: requestBody.RuleStackEntry
      - text: Modify the settings of rulestack {rulestackname}.
        slots:
          rulestackname: path.rulestackname
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/rulestacks/{rulestackname}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a rulestack
      effect: destructive
      questions:
      - How do I remove a rulestack I no longer use?
      - What happens when I delete a Cloud NGFW rulestack?
      instructions:
      - text: Delete rulestack {rulestackname}.
        slots:
          rulestackname: path.rulestackname
      - text: Remove the unused rulestack {rulestackname} permanently.
        slots:
          rulestackname: path.rulestackname
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/rulestacks/{rulestackname}/commit'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a rulestack's commit status
      effect: read
      questions:
      - Has my last rulestack commit succeeded?
      - Is a commit still in progress on this rulestack?
      instructions:
      - text: Check the commit status of rulestack {rulestackname}.
        slots:
          rulestackname: path.rulestackname
      - text: Tell me whether rulestack {rulestackname} finished committing.
        slots:
          rulestackname: path.rulestackname
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/rulestacks/{rulestackname}/commit'].post
  update:
    x-apievangelist-phrasing:
      intent: Commit rulestack changes
      effect: write
      questions:
      - How do I push my pending rulestack edits live?
      - Do rulestack changes take effect before I commit them?
      instructions:
      - text: Commit rulestack {rulestackname}.
        slots:
          rulestackname: path.rulestackname
      - text: Push the pending edits on rulestack {rulestackname} live.
        slots:
          rulestackname: path.rulestackname
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/rulestacks/{rulestackname}/revert'].post
  update:
    x-apievangelist-phrasing:
      intent: Discard uncommitted rulestack changes
      effect: destructive
      questions:
      - Can I throw away the edits I haven't committed on a rulestack?
      - Is there an undo for uncommitted rulestack changes?
      instructions:
      - text: Revert uncommitted changes on rulestack {rulestackname}.
        slots:
          rulestackname: path.rulestackname
      - text: Discard all pending edits to rulestack {rulestackname}.
        slots:
          rulestackname: path.rulestackname
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/rulestacks/{rulestackname}/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a rulestack
      effect: read
      questions:
      - How can I check that a rulestack's configuration is valid?
      - Will validating a rulestack flag errors in its rules?
      instructions:
      - text: Validate rulestack {rulestackname}.
        slots:
          rulestackname: path.rulestackname
      - text: Run a validation check on rulestack {rulestackname}.
        slots:
          rulestackname: path.rulestackname
      method: generated
      generated: '2026-09-26'