Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Prisma Cloud API Overview Rules API

7 actions 7 updates phrasing extends openapi/palo-alto-networks-rules-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Palo Alto Networks's API. It is a proposal applied on top of the contract, not a document Palo Alto Networks publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info

$.paths['/code/api/v1/enforcement-rules/account/{accountId}'].get

$.paths['/code/api/v1/enforcement-rules'].get

$.paths['/code/api/v1/enforcement-rules'].put

$.paths['/code/api/v1/enforcement-rules'].post

$.paths['/code/api/v1/enforcement-rules/{ruleId}'].delete

$.paths['/code/api/v1/enforcement-rules/accounts'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Prisma Cloud API Overview Rules API
  version: 1.0.0
extends: openapi/palo-alto-networks-rules-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: 6
- target: $.paths['/code/api/v1/enforcement-rules/account/{accountId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get enforcement rules for one code account
      effect: read
      questions:
      - Which enforcement thresholds apply to a specific repository account?
      - How do I see the enforcement scheme for one account?
      instructions:
      - text: Show the enforcement scheme for account {accountId}.
        slots:
          accountId: path.accountId
      - text: Get the code security enforcement rules applied to repo account {accountId}.
        slots:
          accountId: path.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/enforcement-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List all code enforcement rules
      effect: read
      questions:
      - What enforcement rules do we have across IaC, secrets, images and open source?
      - What behavior threshold is set for each code category?
      instructions:
      - text: List all our code security enforcement rules.
      - text: Show every enforcement rule with its per-category thresholds.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/enforcement-rules'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a code enforcement rule or exception
      effect: write
      questions:
      - How do I change the thresholds on an existing enforcement rule?
      - Can I change which repositories an exception rule applies to?
      instructions:
      - text: Update enforcement rule {id} named {name} with categories {codeCategories} on repositories {repositories}.
        slots:
          id: requestBody.id
          name: requestBody.name
          codeCategories: requestBody.codeCategories
          repositories: requestBody.repositories
      - text: Edit exception {id} ({name}) so it covers repos {repositories} with thresholds {codeCategories}.
        slots:
          id: requestBody.id
          name: requestBody.name
          repositories: requestBody.repositories
          codeCategories: requestBody.codeCategories
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/enforcement-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an enforcement exception for repositories
      effect: write
      questions:
      - How do I relax enforcement thresholds for a specific set of repositories?
      - Can I add a new exception rule instead of changing the main rule?
      instructions:
      - text: Create enforcement exception {name} for repositories {repositories} with thresholds {codeCategories}.
        slots:
          name: requestBody.name
          repositories: requestBody.repositories
          codeCategories: requestBody.codeCategories
      - text: Add a new exception rule {name} covering {repositories} using categories {codeCategories}.
        slots:
          name: requestBody.name
          repositories: requestBody.repositories
          codeCategories: requestBody.codeCategories
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/enforcement-rules/{ruleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an enforcement exception rule
      effect: destructive
      questions:
      - How do I remove an enforcement exception we no longer need?
      - Why can't I delete the main enforcement rule?
      instructions:
      - text: Delete enforcement exception {ruleId}.
        slots:
          ruleId: path.ruleId
      - text: Remove exception rule {ruleId} from future scan runs.
        slots:
          ruleId: path.ruleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/enforcement-rules/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List build-time repository accounts
      effect: read
      questions:
      - Which repositories are connected for build-time code scanning?
      - Can I search connected repository accounts by name?
      instructions:
      - text: List all build-time repository accounts.
      - text: Search repository accounts for {search}, page {page}.
        slots:
          search: query.search
          page: query.page
      method: generated
      generated: '2026-09-26'