Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Services API

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

$.info
$.paths['/services/get_services'].post
$.paths['/services'].get
$.paths['/services'].post
$.paths['/services/{id}'].get
$.paths['/services/{id}'].put
$.paths['/services/{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 Palo Alto Networks Services API
  version: 1.0.0
extends: openapi/palo-alto-networks-services-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['/services/get_services'].post
  update:
    x-apievangelist-phrasing:
      intent: Find internet-exposed services
      effect: read
      questions:
      - Which open ports and protocols are exposed to the internet on my assets?
      - Can I filter exposed services by country or port?
      instructions:
      - text: Get internet-exposed services discovered by Xpanse matching {request_data}.
        slots:
          request_data: requestBody.request_data
      - text: List all exposed services Xpanse has observed on my internet-facing assets.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/services'].get
  update:
    x-apievangelist-phrasing:
      intent: List service objects
      effect: read
      questions:
      - Which service objects are defined in my security configuration folder?
      - Can I list service objects scoped to one snippet?
      instructions:
      - text: List service objects in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the service object named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/services'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a service object
      effect: write
      questions:
      - How do I define a new service object with a protocol and port?
      - Can I tag a service object when I create it?
      instructions:
      - text: Create service object {name} with protocol {protocol}.
        slots:
          name: requestBody.name
          protocol: requestBody.protocol
      - text: Add service {name} tagged {tag}.
        slots:
          name: requestBody.name
          tag: requestBody.tag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/services/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a service object
      effect: read
      questions:
      - What protocol and ports does a specific service object define?
      - Can I fetch one service object by UUID?
      instructions:
      - text: Get service object {id}.
        slots:
          id: path.id
      - text: Show the protocol settings of service {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/services/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a service object
      effect: write
      questions:
      - Can I change the port on an existing service object?
      - Is it possible to retag a service object?
      instructions:
      - text: Update service {id} named {name} to protocol {protocol}.
        slots:
          id: path.id
          name: requestBody.name
          protocol: requestBody.protocol
      - text: Set tags on service object {id} called {name} to {tag}.
        slots:
          id: path.id
          name: requestBody.name
          tag: requestBody.tag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/services/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a service object
      effect: destructive
      questions:
      - Can I remove a service object that no rule uses anymore?
      - What happens when I delete a service object?
      instructions:
      - text: Delete service object {id}.
        slots:
          id: path.id
      - text: Remove the service with UUID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'