Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Security Services Application Override Rules API

13 actions 13 updates phrasing extends openapi/palo-alto-networks-application-override-rules-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 13

$.info
$.paths['/app-override-rules'].get
$.paths['/app-override-rules'].post
$.paths['/app-override-rules/{id}'].get
$.paths['/app-override-rules/{id}'].put
$.paths['/app-override-rules/{id}'].delete
$.paths['/app-override-rules/{id}:move'].post
$.paths['/sse/config/v1/app-override-rules'].get
$.paths['/sse/config/v1/app-override-rules'].post
$.paths['/sse/config/v1/app-override-rules/{id}'].get
$.paths['/sse/config/v1/app-override-rules/{id}'].put
$.paths['/sse/config/v1/app-override-rules/{id}'].delete
$.paths['/sse/config/v1/app-override-rules/{id}:move'].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 Security Services Application Override Rules API
  version: 1.0.0
extends: openapi/palo-alto-networks-application-override-rules-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: 12
- target: $.paths['/app-override-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List application override rules
      effect: read
      questions:
      - Which application override rules exist in a given folder?
      - Can I list only the pre-rules or post-rules for app overrides?
      instructions:
      - text: List {position} application override rules in folder {folder}.
        slots:
          position: query.position
          folder: query.folder
      - text: Find the {position} app override rule named {name}.
        slots:
          position: query.position
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/app-override-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an application override rule
      effect: write
      questions:
      - How do I force traffic on a certain port to be identified as a specific application?
      - Can I add an app override rule for a given protocol and port?
      instructions:
      - text: Create a {position} app override rule {name} mapping {protocol} port {port} to application {application}.
        slots:
          position: query.position
          name: requestBody.name
          protocol: requestBody.protocol
          port: requestBody.port
          application: requestBody.application
      - text: Add application override rule {name} at position {position} from zone {from} to zone {to}.
        slots:
          name: requestBody.name
          position: query.position
          from: requestBody.from
          to: requestBody.to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/app-override-rules/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an application override rule
      effect: read
      questions:
      - What ports and application does a specific override rule use?
      - How do I view one application override rule by its ID?
      instructions:
      - text: Get application override rule {id}.
        slots:
          id: path.id
      - text: Show the settings of app override rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/app-override-rules/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an application override rule
      effect: write
      questions:
      - Can I change the port on an existing application override rule?
      - How do I disable an app override rule without deleting it?
      instructions:
      - text: Change the port of app override rule {id} ({name}) to {port}.
        slots:
          id: path.id
          name: requestBody.name
          port: requestBody.port
      - text: Set disabled to {disabled} on application override rule {id} named {name}.
        slots:
          disabled: requestBody.disabled
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/app-override-rules/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an application override rule
      effect: destructive
      questions:
      - How do I remove an application override rule?
      - Is deleting an app override rule reversible?
      instructions:
      - text: Delete application override rule {id}.
        slots:
          id: path.id
      - text: Remove app override rule {id} from the configuration.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/app-override-rules/{id}:move'].post
  update:
    x-apievangelist-phrasing:
      intent: Reorder an application override rule
      effect: write
      questions:
      - Can I move an app override rule above or below another rule?
      - How do I move an application override rule to the top of the rulebase?
      instructions:
      - text: Move app override rule {id} to {destination} in the {rulebase} rulebase.
        slots:
          id: path.id
          destination: requestBody.destination
          rulebase: requestBody.rulebase
      - text: Place application override rule {id} {destination} rule {destination_rule} in the {rulebase} rulebase.
        slots:
          id: path.id
          destination: requestBody.destination
          destination_rule: requestBody.destination_rule
          rulebase: requestBody.rulebase
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/app-override-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List application override rules
      effect: read
      questions:
      - Which application override rules are in a folder's pre or post rulebase?
      - Can I find an app override rule by name?
      instructions:
      - text: List app override rules in folder {folder} at position {position}.
        slots:
          folder: query.folder
          position: query.position
      - text: Find the app override rule named {name} in folder {folder}, position {position}.
        slots:
          name: query.name
          folder: query.folder
          position: query.position
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/app-override-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an application override rule
      effect: write
      questions:
      - How do I force traffic on a specific port and protocol to be identified as a custom application?
      - What must I specify when adding a new app override rule?
      instructions:
      - text: Create app override rule {name} in folder {folder} ({position}) mapping {protocol} port {port} to {application}.
        slots:
          name: requestBody.name
          folder: query.folder
          position: query.position
          protocol: requestBody.protocol
          port: requestBody.port
          application: requestBody.application
      - text: Add override rule {name} from zone {from} to {to}, source {source} to destination {destination}, {protocol}/{port} as {application}, folder {folder} {position}.
        slots:
          name: requestBody.name
          from: requestBody.from
          to: requestBody.to
          source: requestBody.source
          destination: requestBody.destination
          protocol: requestBody.protocol
          port: requestBody.port
          application: requestBody.application
          folder: query.folder
          position: query.position
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/app-override-rules/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an application override rule
      effect: read
      questions:
      - Where can I see one app override rule's full settings by ID?
      - What port, protocol and application does a given override rule use?
      instructions:
      - text: Get app override rule {id} in folder {folder}.
        slots:
          id: path.id
          folder: query.folder
      - text: Show the settings of override rule {id} from folder {folder}.
        slots:
          id: path.id
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/app-override-rules/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit an application override rule
      effect: write
      questions:
      - Can I change the port or application of an existing app override rule?
      - Through the SSE config v1 path, how do I disable an app override rule but keep it?
      instructions:
      - text: Update override rule {id} ({name}) to map {protocol} port {port} to {application}.
        slots:
          id: path.id
          name: requestBody.name
          protocol: requestBody.protocol
          port: requestBody.port
          application: requestBody.application
      - text: Set disabled to {disabled} on app override rule {id}.
        slots:
          disabled: requestBody.disabled
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/app-override-rules/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an application override rule
      effect: destructive
      questions:
      - Can I remove an application override rule I no longer need?
      - Is an app override rule deleted by its ID?
      instructions:
      - text: Delete app override rule {id}.
        slots:
          id: path.id
      - text: Remove application override rule {id} from the rulebase.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/app-override-rules/{id}:move'].post
  update:
    x-apievangelist-phrasing:
      intent: Reorder an application override rule
      effect: write
      questions:
      - Using the SSE config v1 move action, how do I put an app override rule at the top of a rulebase?
      - Can I place an override rule directly before or after another rule?
      instructions:
      - text: Move app override rule {id} in folder {folder} to {destination} of the {rulebase} rulebase.
        slots:
          id: path.id
          folder: query.folder
          destination: requestBody.destination
          rulebase: requestBody.rulebase
      - text: Move override rule {id} {destination} rule {destination_rule} in the {rulebase} rulebase of folder {folder}.
        slots:
          id: path.id
          destination: requestBody.destination
          destination_rule: requestBody.destination_rule
          rulebase: requestBody.rulebase
          folder: query.folder
      method: generated
      generated: '2026-10-01'