Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Device Settings Service Route Settings API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-service-route-settings-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['/service-route'].get
$.paths['/service-route'].post
$.paths['/service-route/{id}'].get
$.paths['/service-route/{id}'].put
$.paths['/service-route/{id}'].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 Device Settings Service Route Settings API
  version: 1.0.0
extends: openapi/palo-alto-networks-service-route-settings-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['/service-route'].get
  update:
    x-apievangelist-phrasing:
      intent: List service route settings
      effect: read
      questions:
      - Which service routes are configured on my firewalls?
      - Can I see service route settings for a specific folder, snippet or device?
      instructions:
      - text: List all service route settings.
      - text: Show service route settings for device {device}.
        slots:
          device: query.device
      - text: List service route settings in folder {folder}.
        slots:
          folder: query.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/service-route'].post
  update:
    x-apievangelist-phrasing:
      intent: Create service route settings
      effect: write
      questions:
      - How do I define which interface a firewall uses to reach services like DNS or syslog?
      - Can I create new service route settings with custom routes?
      instructions:
      - text: Create service route settings with routes {route}.
        slots:
          route: requestBody.route
      - text: Add a new service route configuration using {route}.
        slots:
          route: requestBody.route
      method: generated
      generated: '2026-09-26'
- target: $.paths['/service-route/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get service route settings
      effect: read
      questions:
      - What routes are in a particular service route settings entry?
      - Can I fetch service route settings by ID?
      instructions:
      - text: Show service route settings {id}.
        slots:
          id: path.id
      - text: Get the routes defined in service route settings {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/service-route/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update service route settings
      effect: write
      questions:
      - How do I change the routes in existing service route settings?
      - Can I point a service to a different source interface on existing settings?
      instructions:
      - text: Update service route settings {id} with routes {route}.
        slots:
          id: path.id
          route: requestBody.route
      - text: Replace the routes on service route settings {id} with {route}.
        slots:
          id: path.id
          route: requestBody.route
      method: generated
      generated: '2026-09-26'
- target: $.paths['/service-route/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete service route settings
      effect: destructive
      questions:
      - How do I delete a service route settings entry?
      - What happens to management traffic if I remove service route settings?
      instructions:
      - text: Delete service route settings {id}.
        slots:
          id: path.id
      - text: Remove service route configuration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'