# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Objects HIP Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-hip-profiles-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-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List HIP profiles
      effect: read
      questions:
      - Which host information profiles are defined for GlobalProtect posture checks?
      - Can I list HIP profiles in a particular folder?
      instructions:
      - text: List HIP profiles in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the HIP profile named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hip-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a HIP profile
      effect: write
      questions:
      - How do I create a HIP profile that matches compliant endpoints?
      - What match expression does a new HIP profile need?
      instructions:
      - text: Create HIP profile {name} with ID {id} and match {match}.
        slots:
          name: requestBody.name
          id: requestBody.id
          match: requestBody.match
      - text: Add HIP profile {name} (ID {id}) matching {match}, described as {description}.
        slots:
          name: requestBody.name
          id: requestBody.id
          match: requestBody.match
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hip-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a HIP profile
      effect: read
      questions:
      - What match criteria does a particular HIP profile use?
      - Can I retrieve a HIP profile by its UUID?
      instructions:
      - text: Get HIP profile {id}.
        slots:
          id: path.id
      - text: Show the match expression of HIP profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hip-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a HIP profile
      effect: write
      questions:
      - How do I change the match condition on an existing HIP profile?
      - Can I rename a HIP profile I already created?
      instructions:
      - text: 'Update HIP profile {id}: name {name}, body ID {body_id}, match {match}.'
        slots:
          id: path.id
          name: requestBody.name
          body_id: requestBody.id
          match: requestBody.match
      - text: Change HIP profile {id} to match {match}.
        slots:
          id: path.id
          match: requestBody.match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hip-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a HIP profile
      effect: destructive
      questions:
      - How do I delete a HIP profile?
      - Is a HIP profile removed permanently when I delete it?
      instructions:
      - text: Delete HIP profile {id}.
        slots:
          id: path.id
      - text: Remove the host information profile with UUID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/hip-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List HIP profiles
      effect: read
      questions:
      - Which host information profiles are defined in a folder?
      - Can I find a HIP profile by name?
      instructions:
      - text: List the HIP profiles in folder {folder}.
        slots:
          folder: query.folder
      - text: Find HIP profile {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/hip-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a HIP profile
      effect: write
      questions:
      - How do I create a host information profile to check endpoint posture?
      - What match expression must a HIP profile created in a folder include?
      instructions:
      - text: Create HIP profile {name} in folder {folder} matching {match}.
        slots:
          name: requestBody.name
          folder: query.folder
          match: requestBody.match
      - text: Add a HIP profile named {name} with match {match} and description {description} to folder {folder}.
        slots:
          name: requestBody.name
          match: requestBody.match
          description: requestBody.description
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/hip-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a HIP profile
      effect: read
      questions:
      - Through the SSE config v1 path, what match criteria does a HIP profile use?
      - Can I pull up a single HIP profile by its ID?
      instructions:
      - text: Get HIP profile {id} from the SSE config v1 path.
        slots:
          id: path.id
      - text: Show the match expression of HIP profile {id} via the SSE config v1 endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/hip-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a HIP profile
      effect: write
      questions:
      - How do I change the posture check in an existing HIP profile?
      - Can I rename an existing HIP profile?
      instructions:
      - text: Edit HIP profile {id} to match {match}.
        slots:
          id: path.id
          match: requestBody.match
      - text: Rename existing HIP profile {id} to {name} with match {match}.
        slots:
          id: path.id
          name: requestBody.name
          match: requestBody.match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/hip-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a HIP profile
      effect: destructive
      questions:
      - What's the way to remove a HIP profile?
      - Can I delete a host information profile I no longer reference?
      instructions:
      - text: Delete HIP profile {id} using the SSE config v1 endpoint.
        slots:
          id: path.id
      - text: Remove the host information profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'