# 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 Regions API
  version: 1.0.0
extends: openapi/palo-alto-networks-regions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/sse/config/v1/regions'].get
  update:
    x-apievangelist-phrasing:
      intent: List region objects in an SSE folder
      effect: read
      questions:
      - Which region objects are defined in a given SSE config folder?
      - Can I search SSE region objects by name?
      instructions:
      - text: List region objects in SSE folder {folder}.
        slots:
          folder: query.folder
      - text: Find the SSE region named {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/regions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a region object (SSE config v1)
      effect: write
      questions:
      - How do I define a custom region with a geo location on the SSE v1 API?
      - Can an SSE region object hold a list of IP addresses?
      instructions:
      - text: Create SSE region {name} in folder {folder}.
        slots:
          name: requestBody.name
          folder: query.folder
      - text: Add SSE region {name} at geo location {geo_location} with addresses {address} in folder {folder}.
        slots:
          name: requestBody.name
          geo_location: requestBody.geo_location
          address: requestBody.address
          folder: query.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/regions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a region object by ID (SSE config v1)
      effect: read
      questions:
      - What addresses and coordinates does one SSE region object contain?
      - Can I fetch a region from the sse/config/v1 path by its ID?
      instructions:
      - text: Show SSE region {id}.
        slots:
          id: path.id
      - text: Get the sse/config/v1 region with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/regions/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a region object (SSE config v1)
      effect: write
      questions:
      - Can I change the IP addresses on an SSE region object?
      - How do I rename a region through the SSE config v1 API?
      instructions:
      - text: Edit SSE region {id} to use addresses {address}.
        slots:
          id: path.id
          address: requestBody.address
      - text: Rename SSE region {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/regions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a region object (SSE config v1)
      effect: destructive
      questions:
      - How do I remove a custom region using the SSE config v1 path?
      - Will deleting an SSE region object affect policies that reference it?
      instructions:
      - text: Delete SSE region {id}.
        slots:
          id: path.id
      - text: Remove the sse/config/v1 region {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/regions'].get
  update:
    x-apievangelist-phrasing:
      intent: List region objects by folder, snippet or device
      effect: read
      questions:
      - What region objects exist on a particular device or snippet?
      - Can I filter region objects by snippet instead of folder?
      instructions:
      - text: List region objects in snippet {snippet}.
        slots:
          snippet: query.snippet
      - text: List regions configured on device {device}.
        slots:
          device: query.device
      method: generated
      generated: '2026-09-26'
- target: $.paths['/regions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a region object
      effect: write
      questions:
      - What's required to create a region object outside the SSE config path?
      - Can a region carry both latitude/longitude and IP addresses?
      instructions:
      - text: Create region {name} with ID {id}.
        slots:
          name: requestBody.name
          id: requestBody.id
      - text: Add region {name} ({id}) at {geo_location}.
        slots:
          name: requestBody.name
          id: requestBody.id
          geo_location: requestBody.geo_location
      method: generated
      generated: '2026-09-26'
- target: $.paths['/regions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a region object
      effect: read
      questions:
      - How can I read an existing region object's addresses?
      - Which geo location is set on a given region?
      instructions:
      - text: Get region {id}.
        slots:
          id: path.id
      - text: Show the geo location of region {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/regions/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a region object
      effect: write
      questions:
      - Can I update a region's geo location after creating it?
      - Is the region ID required in the body when updating a region?
      instructions:
      - text: Update region {id} to geo location {geo_location}.
        slots:
          id: path.id
          geo_location: requestBody.geo_location
      - text: Update region {id} name to {name} and addresses to {address}.
        slots:
          id: path.id
          name: requestBody.name
          address: requestBody.address
      method: generated
      generated: '2026-09-26'
- target: $.paths['/regions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a region object
      effect: destructive
      questions:
      - How do I delete a region object that isn't under the SSE path?
      - Can a region still be deleted if nothing references it?
      instructions:
      - text: Delete region {id}.
        slots:
          id: path.id
      - text: Remove the region object {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'