# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Posture Management Checks API
  version: 1.0.0
extends: openapi/palo-alto-networks-checks-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: 8
- target: $.paths['/checks/v1'].get
  update:
    x-apievangelist-phrasing:
      intent: List posture checks
      effect: read
      questions:
      - Which posture checks, custom and predefined, are available to me?
      - Can I filter posture checks by severity or by the object type they inspect, like security rules?
      - What posture checks apply to a particular management platform?
      instructions:
      - text: List all {type} posture checks.
        slots:
          type: query.type
      - text: Show posture checks with severity {severity} for object type {object_type}.
        slots:
          severity: query.severity
          object_type: query.object_type
      - text: List posture checks for management type {management_type}, {limit} at a time.
        slots:
          management_type: query.management_type
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/checks/v1'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom posture check
      effect: write
      questions:
      - How do I write my own posture check against security rules?
      - Does creating a custom posture check need an SCM Pro license?
      instructions:
      - text: Create custom posture check {name} on {object_type} with severity {severity} and rule {data}.
        slots:
          name: requestBody.name
          object_type: requestBody.object_type
          severity: requestBody.severity
          data: requestBody.data
      - text: Add a new posture check {name} for {object_type}, severity {severity}, rule {data}, rationale {rationale}.
        slots:
          name: requestBody.name
          object_type: requestBody.object_type
          severity: requestBody.severity
          data: requestBody.data
          rationale: requestBody.rationale
      method: generated
      generated: '2026-09-26'
- target: $.paths['/checks/v1/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a posture check
      effect: read
      questions:
      - What rule expression and rationale does a specific posture check use?
      - Can I look up a predefined posture check by its ID?
      instructions:
      - text: Get posture check {id}.
        slots:
          id: path.id
      - text: Show the rule definition and severity of posture check {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/checks/v1/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom posture check
      effect: write
      questions:
      - Can I change the severity of one of my custom posture checks?
      - How do I edit the rule expression of an existing custom check?
      instructions:
      - text: Update posture check {id} ({name}, {object_type}) to severity {severity} with rule {data}.
        slots:
          id: path.id
          name: requestBody.name
          object_type: requestBody.object_type
          severity: requestBody.severity
          data: requestBody.data
      - text: Rewrite the rule of custom check {id} to {data}, keeping name {name}, type {object_type}, severity {severity}.
        slots:
          id: path.id
          data: requestBody.data
          name: requestBody.name
          object_type: requestBody.object_type
          severity: requestBody.severity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/checks/v1/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom posture check
      effect: destructive
      questions:
      - How do I delete a single custom posture check?
      - Can predefined checks be deleted, or only custom ones?
      instructions:
      - text: Delete custom posture check {id}.
        slots:
          id: path.id
      - text: Remove posture check {id} from my custom checks.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/checks/v1/{id}:clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone a posture check
      effect: write
      questions:
      - Can I copy a predefined posture check and customize the copy?
      - How do I duplicate a posture check under a new name?
      instructions:
      - text: Clone posture check {id}.
        slots:
          id: path.id
      - text: Make a copy of posture check {id} named {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/checks/v1/batch-upsert'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update many posture checks at once
      effect: write
      questions:
      - Is there a way to create and update many posture checks in a single request?
      - How does a batch upsert decide whether a posture check is new or updated?
      instructions:
      - text: 'Batch upsert these posture checks: {checks}.'
        slots:
          checks: requestBody.checks
      - text: Create or update the posture checks {checks} in one call.
        slots:
          checks: requestBody.checks
      method: generated
      generated: '2026-09-26'
- target: $.paths['/checks/v1/batch-delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete many posture checks at once
      effect: destructive
      questions:
      - Can I delete several custom posture checks in one request?
      - What's the bulk way to remove a list of posture check IDs?
      instructions:
      - text: Batch delete posture checks {ids}.
        slots:
          ids: requestBody.ids
      - text: 'Remove all of these posture check IDs at once: {ids}.'
        slots:
          ids: requestBody.ids
      method: generated
      generated: '2026-09-26'