# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for HIP Objects API
  version: 1.0.0
extends: openapi/palo-alto-networks-hip-objects-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['/hip-objects'].get
  update:
    x-apievangelist-phrasing:
      intent: List HIP objects
      effect: read
      questions:
      - Which host information profile (HIP) objects are defined?
      - Can I list HIP objects for a specific folder, snippet or device?
      instructions:
      - text: List all HIP objects.
      - text: Show HIP objects in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the HIP object named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hip-objects'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a HIP object
      effect: write
      questions:
      - How do I create a HIP object that checks disk encryption on endpoints?
      - Can a HIP object check anti-malware and patch management together?
      instructions:
      - text: Create HIP object {name} with ID {id}.
        slots:
          name: requestBody.name
          id: requestBody.id
      - text: Create HIP object {name} (ID {id}) requiring disk encryption {disk_encryption}.
        slots:
          name: requestBody.name
          id: requestBody.id
          disk_encryption: requestBody.disk_encryption
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hip-objects/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a HIP object
      effect: read
      questions:
      - What endpoint checks does a particular HIP object define?
      - Can I fetch a HIP object by ID?
      instructions:
      - text: Show HIP object {id}.
        slots:
          id: path.id
      - text: Get the host checks defined in HIP object {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hip-objects/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a HIP object
      effect: write
      questions:
      - How do I change the checks in an existing HIP object?
      - Can I add a firewall requirement to a HIP object I already have?
      instructions:
      - text: Update HIP object {id} named {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set the anti-malware check on HIP object {id} to {anti_malware}.
        slots:
          id: path.id
          anti_malware: requestBody.anti_malware
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hip-objects/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a HIP object
      effect: destructive
      questions:
      - How do I delete a HIP object?
      - Will HIP profiles that reference an object break if I remove it?
      instructions:
      - text: Delete HIP object {id}.
        slots:
          id: path.id
      - text: Remove the unused HIP object {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/hip-objects'].get
  update:
    x-apievangelist-phrasing:
      intent: List HIP objects
      effect: read
      questions:
      - Which host information profile objects are defined in a folder?
      - Can I search HIP objects by name?
      instructions:
      - text: List HIP objects in folder {folder}.
        slots:
          folder: query.folder
      - text: Find HIP object {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/hip-objects'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a HIP object
      effect: write
      questions:
      - How do I create a HIP object that checks for disk encryption or anti-malware?
      - Can a new HIP object include custom checks and patch management criteria?
      instructions:
      - text: Create HIP object {name} in folder {folder}.
        slots:
          name: requestBody.name
          folder: query.folder
      - text: Add HIP object {name} to {folder} requiring disk encryption {disk_encryption}.
        slots:
          name: requestBody.name
          folder: query.folder
          disk_encryption: requestBody.disk_encryption
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/hip-objects/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a HIP object
      effect: read
      questions:
      - How do I view one HIP object's match criteria by ID?
      - What device posture checks does a specific HIP object contain?
      instructions:
      - text: Get HIP object {id}.
        slots:
          id: path.id
      - text: Show the posture criteria of HIP object {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/hip-objects/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a HIP object
      effect: write
      questions:
      - How do I change the criteria of an existing HIP object?
      - Via the SSE config v1 path, can I add a firewall requirement to an existing HIP object?
      instructions:
      - text: Edit HIP object {id} named {name} through the SSE config v1 path.
        slots:
          id: path.id
          name: requestBody.name
      - text: Edit HIP object {id} ({name}) to require firewall {firewall}.
        slots:
          id: path.id
          name: requestBody.name
          firewall: requestBody.firewall
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/hip-objects/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a HIP object
      effect: destructive
      questions:
      - How do I delete a HIP object using the SSE config v1 path?
      - Can I remove a host information profile object by ID?
      instructions:
      - text: Delete HIP object {id} using the SSE config v1 endpoint.
        slots:
          id: path.id
      - text: Remove the HIP object with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'