Palo Alto Networks · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Objects Service Groups API
11 actions
11 updates
phrasing
extends
openapi/palo-alto-networks-service-groups-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.
What the actions change
x-apievangelist-phrasing
Targets 11
$.info
$.paths['/service-groups'].get
$.paths['/service-groups'].post
$.paths['/service-groups/{id}'].get
$.paths['/service-groups/{id}'].put
$.paths['/service-groups/{id}'].delete
$.paths['/sse/config/v1/service-groups'].get
$.paths['/sse/config/v1/service-groups'].post
$.paths['/sse/config/v1/service-groups/{id}'].get
$.paths['/sse/config/v1/service-groups/{id}'].put
$.paths['/sse/config/v1/service-groups/{id}'].delete
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Objects Service Groups API
version: 1.0.0
extends: openapi/palo-alto-networks-service-groups-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['/service-groups'].get
update:
x-apievangelist-phrasing:
intent: List service groups
effect: read
questions:
- Which service groups are defined in a given folder?
- Can I search service groups by name?
instructions:
- text: List service groups in folder {folder}.
slots:
folder: query.folder
- text: Find service groups named {name}.
slots:
name: query.name
method: generated
generated: '2026-09-26'
- target: $.paths['/service-groups'].post
update:
x-apievangelist-phrasing:
intent: Create a service group
effect: write
questions:
- How do I bundle several services into one group for security rules?
- Can I tag a service group when creating it?
instructions:
- text: Create service group {name} with members {members} and UUID {id}.
slots:
name: requestBody.name
members: requestBody.members
id: requestBody.id
- text: Add service group {name} ({id}) containing {members}, tagged {tag}.
slots:
name: requestBody.name
id: requestBody.id
members: requestBody.members
tag: requestBody.tag
method: generated
generated: '2026-09-26'
- target: $.paths['/service-groups/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a service group
effect: read
questions:
- Which services belong to a specific service group?
- Can I fetch a service group by UUID?
instructions:
- text: Get service group {id}.
slots:
id: path.id
- text: Show the members of service group {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/service-groups/{id}'].put
update:
x-apievangelist-phrasing:
intent: Update a service group
effect: write
questions:
- Can I add a service to an existing service group?
- Is it possible to rename a service group?
instructions:
- text: Set members of service group {id} to {members}, name {name}.
slots:
id: path.id
members: requestBody.members
name: requestBody.name
- text: Rename service group {id} to {name} keeping members {members}.
slots:
id: path.id
name: requestBody.name
members: requestBody.members
method: generated
generated: '2026-09-26'
- target: $.paths['/service-groups/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a service group
effect: destructive
questions:
- How do I remove a service group?
- Can I delete a service group by UUID?
instructions:
- text: Delete service group {id}.
slots:
id: path.id
- text: Remove service group with UUID {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/sse/config/v1/service-groups'].get
update:
x-apievangelist-phrasing:
intent: List service groups
effect: read
questions:
- Which service groups exist in a configuration folder?
- Can I search the SSE config v1 service groups by name within a folder?
instructions:
- text: List the SSE config service groups in folder {folder}.
slots:
folder: query.folder
- text: Find service group {name} in folder {folder}.
slots:
name: query.name
folder: query.folder
method: generated
generated: '2026-10-01'
- target: $.paths['/sse/config/v1/service-groups'].post
update:
x-apievangelist-phrasing:
intent: Create a service group
effect: write
questions:
- How do I bundle several services into one service group?
- Can I tag a new service group when I create it?
instructions:
- text: Create service group {name} in folder {folder} with members {members}.
slots:
name: requestBody.name
folder: query.folder
members: requestBody.members
- text: Add service group {name} to {folder} containing {members}, tagged {tag}.
slots:
name: requestBody.name
folder: query.folder
members: requestBody.members
tag: requestBody.tag
method: generated
generated: '2026-10-01'
- target: $.paths['/sse/config/v1/service-groups/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a service group
effect: read
questions:
- How do I see which services are in a specific service group?
- Can I fetch a service group by its ID?
instructions:
- text: Fetch SSE config service group {id}.
slots:
id: path.id
- text: Show the SSE v1 members list of service group {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/sse/config/v1/service-groups/{id}'].put
update:
x-apievangelist-phrasing:
intent: Edit a service group
effect: write
questions:
- How do I add or remove services in an existing service group?
- Can I rename a service group I already created?
instructions:
- text: Update service group {id} ({name}) to members {members}.
slots:
id: path.id
name: requestBody.name
members: requestBody.members
- text: Edit SSE v1 service group {id} to be named {name} with members {members}.
slots:
id: path.id
name: requestBody.name
members: requestBody.members
method: generated
generated: '2026-10-01'
- target: $.paths['/sse/config/v1/service-groups/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a service group
effect: destructive
questions:
- How do I delete a service group?
- Can I remove a service group by its ID?
instructions:
- text: Delete SSE config service group {id}.
slots:
id: path.id
- text: Remove the service group with ID {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'