# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Network Deployment Traffic Steering Rules API
  version: 1.0.0
extends: openapi/palo-alto-networks-traffic-steering-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: 10
- target: $.paths['/traffic-steering-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List Service Connection traffic steering rules
      effect: read
      questions:
      - Which traffic steering rules route traffic to Service Connections?
      - Can I find a steering rule by name within a folder?
      instructions:
      - text: List traffic steering rules in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the steering rule named {name} in {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/traffic-steering-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a traffic steering rule
      effect: write
      questions:
      - How do I steer certain traffic through a Service Connection?
      - What source and service do I need to define a new steering rule?
      instructions:
      - text: Create steering rule {name} (ID {id}) in {folder} for source {source} and service {service}.
        slots:
          name: requestBody.name
          id: requestBody.id
          folder: query.folder
          source: requestBody.source
          service: requestBody.service
      - text: Add a rule in {folder} sending {service} traffic to {destination}, ID {id}, named {name}, source {source}.
        slots:
          folder: query.folder
          service: requestBody.service
          destination: requestBody.destination
          id: requestBody.id
          name: requestBody.name
          source: requestBody.source
      method: generated
      generated: '2026-09-26'
- target: $.paths['/traffic-steering-rules/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a traffic steering rule
      effect: read
      questions:
      - What source, destination and action does a specific steering rule use?
      - Can I fetch one traffic steering rule by UUID?
      instructions:
      - text: Get traffic steering rule {id}.
        slots:
          id: path.id
      - text: Show the match criteria of steering rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/traffic-steering-rules/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a traffic steering rule
      effect: write
      questions:
      - How do I change the action on an existing steering rule?
      - Can I edit the source users of a traffic steering rule?
      instructions:
      - text: 'Update existing steering rule {id}: name {name}, source {source}, service {service}.'
        slots:
          id: path.id
          name: requestBody.name
          source: requestBody.source
          service: requestBody.service
      - text: Change the action of steering rule {id} to {action}.
        slots:
          id: path.id
          action: requestBody.action
      method: generated
      generated: '2026-09-26'
- target: $.paths['/traffic-steering-rules/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a traffic steering rule
      effect: destructive
      questions:
      - How do I remove a traffic steering rule?
      - Can a steering rule be deleted by UUID?
      instructions:
      - text: Delete traffic steering rule {id}.
        slots:
          id: path.id
      - text: Remove the steering rule with UUID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/traffic-steering-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List traffic steering rules
      effect: read
      questions:
      - Which traffic steering rules send traffic to my service connections?
      - Can I list the traffic steering rules in a particular folder?
      instructions:
      - text: List traffic steering rules in folder {folder} through the SSE config v1 path.
        slots:
          folder: query.folder
      - text: Find the traffic steering rule named {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/traffic-steering-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a traffic steering rule
      effect: write
      questions:
      - How do I steer traffic from certain sources to a service connection?
      - Can a steering rule target specific users and destinations?
      instructions:
      - text: Create traffic steering rule {name} in folder {folder} for source {source} and service {service}.
        slots:
          name: requestBody.name
          folder: query.folder
          source: requestBody.source
          service: requestBody.service
      - text: Add a steering rule {name} in {folder} that sends users {source_user} to destination {destination} with action {action}, service {service}, source {source}.
        slots:
          name: requestBody.name
          folder: query.folder
          source_user: requestBody.source_user
          destination: requestBody.destination
          action: requestBody.action
          service: requestBody.service
          source: requestBody.source
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/traffic-steering-rules/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a traffic steering rule
      effect: read
      questions:
      - What sources and destinations does a particular steering rule match?
      - How do I view one traffic steering rule by ID?
      instructions:
      - text: Get traffic steering rule {id} from the SSE config v1 path.
        slots:
          id: path.id
      - text: Show the match criteria of steering rule {id} via the SSE config v1 endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/traffic-steering-rules/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a traffic steering rule
      effect: write
      questions:
      - Can I change the destination of an existing traffic steering rule?
      - How do I edit which source users a steering rule applies to?
      instructions:
      - text: Edit steering rule {id} ({name}) to use source {source}, service {service} and destination {destination}.
        slots:
          id: path.id
          name: requestBody.name
          source: requestBody.source
          service: requestBody.service
          destination: requestBody.destination
      - text: Change the action of traffic steering rule {id} named {name} to {action}, keeping source {source} and service {service}.
        slots:
          id: path.id
          name: requestBody.name
          action: requestBody.action
          source: requestBody.source
          service: requestBody.service
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/traffic-steering-rules/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a traffic steering rule
      effect: destructive
      questions:
      - How do I remove a traffic steering rule using the SSE config v1 path?
      - Is deleting a steering rule reversible?
      instructions:
      - text: Delete traffic steering rule {id} using the SSE config v1 endpoint.
        slots:
          id: path.id
      - text: Remove the steering rule with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'