Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Security Services Profile Groups API

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 11

$.info

$.paths['/profile-groups'].get

$.paths['/profile-groups'].post

$.paths['/profile-groups/{id}'].get

$.paths['/profile-groups/{id}'].put

$.paths['/profile-groups/{id}'].delete

$.paths['/sse/config/v1/profile-groups'].get

$.paths['/sse/config/v1/profile-groups'].post

$.paths['/sse/config/v1/profile-groups/{id}'].get

$.paths['/sse/config/v1/profile-groups/{id}'].put

$.paths['/sse/config/v1/profile-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 Security Services Profile Groups API
  version: 1.0.0
extends: openapi/palo-alto-networks-profile-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['/profile-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List security profile groups
      effect: read
      questions:
      - Which security profile groups are available for my rules?
      - Can I list profile groups defined in a given snippet?
      instructions:
      - text: List profile groups in snippet {snippet}.
        slots:
          snippet: query.snippet
      - text: Find the profile group named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/profile-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a security profile group
      effect: write
      questions:
      - How do I bundle antivirus, spyware and URL filtering profiles into one group?
      - Can a new profile group include a DNS security profile?
      instructions:
      - text: Create profile group {name}.
        slots:
          name: requestBody.name
      - text: Create profile group {name} using URL filtering profile {url_filtering}.
        slots:
          name: requestBody.name
          url_filtering: requestBody.url_filtering
      method: generated
      generated: '2026-09-26'
- target: $.paths['/profile-groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a security profile group
      effect: read
      questions:
      - Which profiles are inside a particular profile group?
      - Can I retrieve a profile group by UUID?
      instructions:
      - text: Get profile group {id}.
        slots:
          id: path.id
      - text: Show the member profiles of profile group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/profile-groups/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a security profile group
      effect: write
      questions:
      - How do I swap the vulnerability profile in an existing group?
      - Can I add file blocking to a profile group I already have?
      instructions:
      - text: Set vulnerability profile {vulnerability} in profile group {id} named {name}.
        slots:
          vulnerability: requestBody.vulnerability
          id: path.id
          name: requestBody.name
      - text: Rename profile group {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/profile-groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a security profile group
      effect: destructive
      questions:
      - How do I delete a profile group?
      - Can I remove a profile group that I no longer reference?
      instructions:
      - text: Delete profile group {id}.
        slots:
          id: path.id
      - text: Remove the security profile group with UUID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/profile-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List security profile groups
      effect: read
      questions:
      - Which security profile groups are defined in a folder?
      - Can I look up a profile group by name?
      instructions:
      - text: List the security profile groups in folder {folder}.
        slots:
          folder: query.folder
      - text: Find profile group {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/profile-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a security profile group
      effect: write
      questions:
      - Can I create a profile group in a folder that bundles vulnerability and spyware profiles?
      - Can a profile group include DNS security and WildFire analysis profiles?
      instructions:
      - text: Create profile group {name} in folder {folder}.
        slots:
          name: requestBody.name
          folder: query.folder
      - text: Create profile group {name} in {folder} with URL filtering {url_filtering} and spyware {spyware}.
        slots:
          name: requestBody.name
          folder: query.folder
          url_filtering: requestBody.url_filtering
          spyware: requestBody.spyware
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/profile-groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a security profile group
      effect: read
      questions:
      - Which security profiles are in a specific profile group?
      - Can I fetch one profile group by ID?
      instructions:
      - text: Get profile group {id} from the SSE config v1 path.
        slots:
          id: path.id
      - text: Show the profiles bundled in profile group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/profile-groups/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a security profile group
      effect: write
      questions:
      - Can I swap the vulnerability profile in an existing profile group?
      - Is it possible to change the file blocking profile of a profile group?
      instructions:
      - text: Set the vulnerability profile of profile group {id} ({name}) to {vulnerability}.
        slots:
          id: path.id
          name: requestBody.name
          vulnerability: requestBody.vulnerability
      - text: Change file blocking in profile group {id} ({name}) to {file_blocking}.
        slots:
          id: path.id
          name: requestBody.name
          file_blocking: requestBody.file_blocking
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/profile-groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a security profile group
      effect: destructive
      questions:
      - How do I delete a security profile group via the SSE config v1 path?
      - Can I remove a profile group by its ID?
      instructions:
      - text: Delete profile group {id} using the SSE config v1 endpoint.
        slots:
          id: path.id
      - text: Remove the security profile group with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'