# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Objects Address Groups API
  version: 1.0.0
extends: openapi/palo-alto-networks-address-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['/address-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List address groups
      effect: read
      questions:
      - Which address groups exist in a given folder?
      - Can I find an address group by name within a snippet?
      instructions:
      - text: List the address groups in folder {folder}.
        slots:
          folder: query.folder
      - text: Find address group {name} in snippet {snippet}.
        slots:
          name: query.name
          snippet: query.snippet
      method: generated
      generated: '2026-09-26'
- target: $.paths['/address-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an address group
      effect: write
      questions:
      - How do I create a new address group with a description and tags?
      - What's required to set up an address group, just an ID and name?
      instructions:
      - text: Create address group {name} with ID {id}.
        slots:
          name: requestBody.name
          id: requestBody.id
      - text: Create address group {name} (ID {id}) tagged {tag} and described as {description}.
        slots:
          name: requestBody.name
          id: requestBody.id
          tag: requestBody.tag
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/address-groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an address group
      effect: read
      questions:
      - What's configured on a specific address group?
      - Can I fetch a single address group by its ID?
      instructions:
      - text: Get address group {id}.
        slots:
          id: path.id
      - text: Show me the details of address group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/address-groups/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an address group
      effect: write
      questions:
      - Can I rename an existing address group or change its tags?
      - What can I edit on an address group after it's created?
      instructions:
      - text: Rename address group {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update address group {id} ({name}) with tags {tag}.
        slots:
          id: path.id
          name: requestBody.name
          tag: requestBody.tag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/address-groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an address group
      effect: destructive
      questions:
      - How do I remove an address group I no longer use?
      - Can I delete an address group by its ID?
      instructions:
      - text: Delete address group {id}.
        slots:
          id: path.id
      - text: Remove address group {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/address-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List firewall address groups
      effect: read
      questions:
      - Which address groups are configured on my firewall, static and dynamic?
      - Can I see which address groups exist in a particular vsys or device group?
      instructions:
      - text: List every address group on the firewall.
      - text: Show the address group named {name}.
        slots:
          name: query.name
      - text: List the SSE config address groups in folder {folder}, {limit} at a time.
        slots:
          folder: query.folder
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/address-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a static or dynamic address group
      effect: write
      questions:
      - Can I build an address group that picks up addresses automatically by tag?
      - What is needed to group several address objects into one new static group?
      instructions:
      - text: Create static address group {name} with member addresses {static}.
        slots:
          name: requestBody.name
          static: requestBody.static
      - text: Create dynamic address group {name} in folder {folder} that matches the tag filter {dynamic}.
        slots:
          name: requestBody.name
          folder: query.folder
          dynamic: requestBody.dynamic
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/address-groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an address group
      effect: read
      questions:
      - What members or filter does a specific address group have?
      - Can I fetch one address group by its ID?
      instructions:
      - text: Fetch the SSE config address group {id} with its static members or dynamic filter.
        slots:
          id: path.id
      - text: Show the members of address group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/address-groups/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an address group definition
      effect: write
      questions:
      - How do I change the members of an existing static address group?
      - Can I rewrite the tag filter on a dynamic address group I already have?
      instructions:
      - text: Replace the static members of address group {id} ({name}) with {static}.
        slots:
          id: path.id
          name: requestBody.name
          static: requestBody.static
      - text: Change the dynamic tag filter of address group {id} ({name}) to {dynamic}.
        slots:
          id: path.id
          name: requestBody.name
          dynamic: requestBody.dynamic
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/address-groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a firewall address group
      effect: destructive
      questions:
      - Is it possible to remove an address group without deleting the address objects inside it?
      - Can I delete a static or dynamic address group from the SSE config by its ID?
      instructions:
      - text: Delete the SSE config address group {id}.
        slots:
          id: path.id
      - text: Remove static or dynamic address group {id} and leave its member addresses in place.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'