Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity Services Local User Groups API

11 actions 11 updates phrasing extends openapi/palo-alto-networks-local-user-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['/local-user-groups'].get
$.paths['/local-user-groups'].post
$.paths['/local-user-groups/{id}'].get
$.paths['/local-user-groups/{id}'].put
$.paths['/local-user-groups/{id}'].delete
$.paths['/sse/config/v1/local-user-groups'].get
$.paths['/sse/config/v1/local-user-groups'].post
$.paths['/sse/config/v1/local-user-groups/{id}'].get
$.paths['/sse/config/v1/local-user-groups/{id}'].put
$.paths['/sse/config/v1/local-user-groups/{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 Identity Services Local User Groups API
  version: 1.0.0
extends: openapi/palo-alto-networks-local-user-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['/local-user-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List local user groups
      effect: read
      questions:
      - Which local user groups are configured?
      - Can I list local user groups for one folder or device?
      instructions:
      - text: List all local user groups.
      - text: Show local user groups in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the local user group named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/local-user-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a local user group
      effect: write
      questions:
      - How do I create a local user group and add users to it?
      - What ID and name does a new local user group need?
      instructions:
      - text: Create local user group {name} with ID {id}.
        slots:
          name: requestBody.name
          id: requestBody.id
      - text: Create local user group {name} (ID {id}) containing users {user}.
        slots:
          name: requestBody.name
          id: requestBody.id
          user: requestBody.user
      method: generated
      generated: '2026-09-26'
- target: $.paths['/local-user-groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a local user group
      effect: read
      questions:
      - Who is in a specific local user group?
      - Can I fetch a local user group by its ID?
      instructions:
      - text: Show local user group {id}.
        slots:
          id: path.id
      - text: List the members of local user group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/local-user-groups/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a local user group
      effect: write
      questions:
      - How do I change the members of an existing local user group?
      - Can I rename a local user group?
      instructions:
      - text: Set the users in local user group {id} to {user}.
        slots:
          id: path.id
          user: requestBody.user
      - text: Rename local user group {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/local-user-groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a local user group
      effect: destructive
      questions:
      - How do I delete a local user group?
      - Is deleting a local user group permanent?
      instructions:
      - text: Delete local user group {id}.
        slots:
          id: path.id
      - text: Remove the unused local user group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/local-user-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List local user groups in a folder
      effect: read
      questions:
      - Which local user groups exist in a given configuration folder?
      - Can I search local user groups by name?
      instructions:
      - text: List local user groups in folder {folder}.
        slots:
          folder: query.folder
      - text: Find local user group {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/local-user-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a local user group
      effect: write
      questions:
      - How do I create a local user group inside a specific folder?
      - Which folder does a new local user group go into?
      instructions:
      - text: Create local user group {name} in folder {folder}.
        slots:
          name: requestBody.name
          folder: query.folder
      - text: Create local user group {name} in {folder} with users {user}.
        slots:
          name: requestBody.name
          folder: query.folder
          user: requestBody.user
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/local-user-groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a local user group
      effect: read
      questions:
      - Which users belong to a specific local user group?
      - Can I fetch one local user group by ID?
      instructions:
      - text: Get local user group {id}.
        slots:
          id: path.id
      - text: Show the members of local user group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/local-user-groups/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a local user group
      effect: write
      questions:
      - Can I change the membership of an existing local user group?
      - Is renaming a local user group supported?
      instructions:
      - text: Set the users of local user group {id} ({name}) to {user}.
        slots:
          id: path.id
          name: requestBody.name
          user: requestBody.user
      - text: Rename local user group {id} to {name} via the SSE config v1 path.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/local-user-groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a local user group
      effect: destructive
      questions:
      - How do I delete a local user group through the SSE config v1 path?
      - Can I remove a local user group by its ID?
      instructions:
      - text: Delete local user group {id} using the SSE config v1 endpoint.
        slots:
          id: path.id
      - text: Remove the local user group with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'