# 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 Suppressions API
  version: 1.0.0
extends: openapi/palo-alto-networks-suppressions-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['/code/api/v1/suppressions'].get
  update:
    x-apievangelist-phrasing:
      intent: List Code Security suppression rules
      effect: read
      questions:
      - Which suppression rules are turned on in Prisma Cloud Application Security?
      - What scopes can a code security suppression cover, like policy, account, tag or resource?
      instructions:
      - text: List every Application Security suppression rule with its scope.
      - text: Show all code security suppressions and which accounts or tags they cover.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/suppressions/{policyId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Suppress a policy by policy ID
      effect: write
      questions:
      - How do I snooze or dismiss a Code Security policy by its policy ID?
      - Can I add a justification when suppressing a policy in Application Security?
      instructions:
      - text: Create a code security suppression for policy {policyId}.
        slots:
          policyId: path.policyId
      - text: Dismiss findings for Application Security policy {policyId} with a new suppression rule.
        slots:
          policyId: path.policyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/suppressions/{policyId}/justifications/{suppressionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a suppression under a policy
      effect: write
      questions:
      - How do I edit an existing suppression rule attached to a policy?
      - Can I change the justification on a suppression I already created?
      instructions:
      - text: Update suppression {suppressionId} on policy {policyId}.
        slots:
          policyId: path.policyId
          suppressionId: path.suppressionId
      - text: Edit the justification of suppression {suppressionId} under policy {policyId}.
        slots:
          policyId: path.policyId
          suppressionId: path.suppressionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/suppressions/{policyId}/justifications/{suppressionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a suppression under a policy
      effect: destructive
      questions:
      - How do I remove a suppression tied to a specific policy and suppression ID?
      - Will errors start showing again after I delete a policy's suppression justification?
      instructions:
      - text: Delete suppression {suppressionId} from policy {policyId}.
        slots:
          policyId: path.policyId
          suppressionId: path.suppressionId
      - text: Remove justification {suppressionId} under Application Security policy {policyId}.
        slots:
          policyId: path.policyId
          suppressionId: path.suppressionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/suppressions/{policyId}/justifications'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a policy's suppression justifications
      effect: read
      questions:
      - Why was a policy suppressed for certain accounts or repositories?
      - Can I see the suppression justifications for one policy across several accounts?
      instructions:
      - text: Show suppression justifications for policy {policyId} in accounts {accounts}.
        slots:
          policyId: path.policyId
          accounts: query.accounts
      - text: Fetch the reasons policy {policyId} is suppressed for repositories {accounts}.
        slots:
          policyId: path.policyId
          accounts: query.accounts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/suppressions'].get
  update:
    x-apievangelist-phrasing:
      intent: List suppressions by policy or scope
      effect: read
      questions:
      - Which suppressions exist for a particular Checkov policy ID?
      - Can I filter suppression rules by scope type, such as repository or file?
      instructions:
      - text: List suppressions for Checkov policy {policyId}.
        slots:
          policyId: query.policyId
      - text: Show suppressions of scope type {suppressionType}.
        slots:
          suppressionType: query.suppressionType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/suppressions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a scoped suppression with expiry
      effect: write
      questions:
      - How do I suppress a Checkov policy for specific resources as an accepted risk?
      - Can a suppression expire automatically on a set date?
      instructions:
      - text: Suppress Checkov policy {policyId} with scope {suppressionType} because {justification}.
        slots:
          policyId: requestBody.policyId
          suppressionType: requestBody.suppressionType
          justification: requestBody.justification
      - text: Suppress {policyId} for resources {resources} with scope {suppressionType} until {expirationDate}.
        slots:
          policyId: requestBody.policyId
          resources: requestBody.resources
          suppressionType: requestBody.suppressionType
          expirationDate: requestBody.expirationDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/suppressions/{suppression_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a suppression by its ID
      effect: destructive
      questions:
      - How do I delete a suppression rule using only its suppression ID?
      - Will suppressed violations get reported again once the suppression is gone?
      instructions:
      - text: Delete suppression rule {suppression_id}.
        slots:
          suppression_id: path.suppression_id
      - text: Remove suppression {suppression_id} so its violations resume reporting.
        slots:
          suppression_id: path.suppression_id
      method: generated
      generated: '2026-09-26'