# 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 Addresses API
  version: 1.0.0
extends: openapi/palo-alto-networks-addresses-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['/addresses'].get
  update:
    x-apievangelist-phrasing:
      intent: List address objects
      effect: read
      questions:
      - Which address objects are configured in a given folder?
      - Can I look up addresses by name in a snippet?
      instructions:
      - text: List the addresses in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the address named {name} in snippet {snippet}.
        slots:
          name: query.name
          snippet: query.snippet
      method: generated
      generated: '2026-09-26'
- target: $.paths['/addresses'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an address with a name and tags
      effect: write
      questions:
      - How do I add a new address with a description and tags?
      - Can I create an address record by giving just an ID and name?
      instructions:
      - text: Create address {name} with ID {id}.
        slots:
          name: requestBody.name
          id: requestBody.id
      - text: Add address {name} (ID {id}) described as {description} and tagged {tag}.
        slots:
          name: requestBody.name
          id: requestBody.id
          description: requestBody.description
          tag: requestBody.tag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/addresses/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an address by ID
      effect: read
      questions:
      - What's stored on the address with a particular ID?
      - Can I pull one address record rather than listing them all?
      instructions:
      - text: Get address {id}.
        slots:
          id: path.id
      - text: Show me the details of address record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/addresses/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an address's name, description or tags
      effect: write
      questions:
      - Can I rename an existing address or change its tags?
      - What fields can I change on an address that already exists?
      instructions:
      - text: Rename address {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update address {id} with description {description} and tags {tag}, keeping name {name}.
        slots:
          id: path.id
          description: requestBody.description
          tag: requestBody.tag
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/addresses/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an address
      effect: destructive
      questions:
      - How do I remove an address I no longer need?
      - Can I delete an address record by its ID?
      instructions:
      - text: Delete address {id}.
        slots:
          id: path.id
      - text: Remove address record {id} for good.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/addresses'].get
  update:
    x-apievangelist-phrasing:
      intent: List firewall address objects
      effect: read
      questions:
      - Which IP addresses, subnets and FQDNs are defined as address objects in my SSE config?
      - Can I page through the address objects in one snippet or on one device?
      - What address objects exist in the Shared folder of my Prisma Access config?
      instructions:
      - text: List all address objects in the SSE config.
      - text: Show the SSE config address objects on device {device}.
        slots:
          device: query.device
      - text: Look up the address object named {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/addresses'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a firewall address object
      effect: write
      questions:
      - How do I define a new IP netmask, IP range or FQDN as a named address object?
      - Does a new address object name have to be unique within its location?
      - Can I add a wildcard address object to use in security rules?
      instructions:
      - text: Create address object {name} for subnet {ip_netmask}.
        slots:
          name: requestBody.name
          ip_netmask: requestBody.ip_netmask
      - text: Add a new address object {name} in folder {folder} pointing to FQDN {fqdn}.
        slots:
          name: requestBody.name
          folder: query.folder
          fqdn: requestBody.fqdn
      - text: Create address object {name} covering the IP range {ip_range}.
        slots:
          name: requestBody.name
          ip_range: requestBody.ip_range
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/addresses/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Prisma Access address object
      effect: read
      questions:
      - What IP or FQDN does a particular address object resolve to?
      - Can I fetch one Prisma Access address object by its unique ID?
      instructions:
      - text: Get Prisma Access address object {id}.
        slots:
          id: path.id
      - text: Show the netmask, range or FQDN on address object {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/addresses/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an address object's definition
      effect: write
      questions:
      - How do I change the IP subnet an existing address object points to?
      - Does editing an address object replace its whole definition or just the fields I send?
      - Can I switch an existing address object from an IP range to an FQDN?
      instructions:
      - text: Replace address object {id} ({name}) so it covers subnet {ip_netmask}.
        slots:
          id: path.id
          name: requestBody.name
          ip_netmask: requestBody.ip_netmask
      - text: Switch address object {id} ({name}) to resolve to FQDN {fqdn}.
        slots:
          id: path.id
          name: requestBody.name
          fqdn: requestBody.fqdn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/addresses/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a firewall address object
      effect: destructive
      questions:
      - Why can't I remove an address object that a security rule still references?
      - What happens if I delete an address object that belongs to an address group?
      instructions:
      - text: Delete Prisma Access address object {id}.
        slots:
          id: path.id
      - text: Remove the unreferenced address object {id} from the SSE config.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'