Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Prisma Cloud API Overview Tag Rules API

8 actions 8 updates phrasing extends openapi/palo-alto-networks-tag-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 8

$.info
$.paths['/code/api/v1/tag-rules'].get
$.paths['/code/api/v1/tag-rules'].post
$.paths['/code/api/v1/tag-rules/{tagRuleId}'].get
$.paths['/code/api/v1/tag-rules/{tagRuleId}'].put
$.paths['/code/api/v1/tag-rules/{tagRuleId}'].delete
$.paths['/code/api/v1/tag-rules/affected-resources'].post
$.paths['/code/api/v1/tag-rules/ootb/{tagRuleOOTBId}'].get

OpenAPI Overlay

Raw ↑
# 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 Tag Rules API
  version: 1.0.0
extends: openapi/palo-alto-networks-tag-rules-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: 7
- target: $.paths['/code/api/v1/tag-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List IaC tag rules
      effect: read
      questions:
      - Which tag rules are applied to our IaC templates?
      - What custom and out-of-the-box tagging rules do we have?
      instructions:
      - text: List all IaC tag rules.
      - text: Show every tag rule in Application Security.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/tag-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom IaC tag rule
      effect: write
      questions:
      - How do I create a rule that automatically tags resources in my IaC?
      - Can a new tag rule target only certain repositories?
      instructions:
      - text: Create tag rule {name} for repositories {repositories} with definition {ruleDefinition}.
        slots:
          name: requestBody.name
          repositories: requestBody.repositories
          ruleDefinition: requestBody.ruleDefinition
      - text: Add tag rule {name} on repos {repositories}, definition {ruleDefinition}, with enabled set to {isEnabled}.
        slots:
          name: requestBody.name
          repositories: requestBody.repositories
          ruleDefinition: requestBody.ruleDefinition
          isEnabled: requestBody.isEnabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/tag-rules/{tagRuleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tag rule
      effect: read
      questions:
      - What does one specific tag rule define?
      - Which repositories is a given tag rule applied to?
      instructions:
      - text: Get tag rule {tagRuleId}.
        slots:
          tagRuleId: path.tagRuleId
      - text: Show the definition of tag rule {tagRuleId}.
        slots:
          tagRuleId: path.tagRuleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/tag-rules/{tagRuleId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an IaC tag rule
      effect: write
      questions:
      - How do I change the definition of a tag rule I already created for my IaC templates?
      - Can I disable an existing tag rule without deleting it?
      - Which repositories does an existing tag rule apply to, and can I change them?
      instructions:
      - text: Update tag rule {tagRuleId} to use rule definition {ruleDefinition}.
        slots:
          tagRuleId: path.tagRuleId
          ruleDefinition: requestBody.ruleDefinition
      - text: Set enabled to {isEnabled} on existing tag rule {tagRuleId}.
        slots:
          tagRuleId: path.tagRuleId
          isEnabled: requestBody.isEnabled
      - text: Change the repositories covered by tag rule {tagRuleId} to {repositories}.
        slots:
          tagRuleId: path.tagRuleId
          repositories: requestBody.repositories
      method: generated
      generated: '2026-10-01'
- target: $.paths['/code/api/v1/tag-rules/{tagRuleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an IaC tag rule
      effect: destructive
      questions:
      - How do I permanently remove a tag rule from Application Security?
      - Can I delete a custom tag rule I no longer want applied to my repositories?
      instructions:
      - text: Delete tag rule {tagRuleId}.
        slots:
          tagRuleId: path.tagRuleId
      - text: Remove the custom IaC tagging rule {tagRuleId} for good.
        slots:
          tagRuleId: path.tagRuleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/code/api/v1/tag-rules/affected-resources'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview resources a tag rule would affect
      effect: read
      questions:
      - Which resources would a tag rule change before I save it?
      - Can I preview a tag rule's impact on one repository?
      instructions:
      - text: Preview resources affected by rule definition {ruleDefinition} in repository {repository}.
        slots:
          ruleDefinition: requestBody.ruleDefinition
          repository: requestBody.repository
      - text: List resources in {repository} a tag rule would touch.
        slots:
          repository: requestBody.repository
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/tag-rules/ootb/{tagRuleOOTBId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an out-of-the-box tag rule
      effect: read
      questions:
      - What does a built-in (out-of-the-box) tag rule do?
      - Can I look up a default tag rule by its OOTB ID?
      instructions:
      - text: Get out-of-the-box tag rule {tagRuleOOTBId}.
        slots:
          tagRuleOOTBId: path.tagRuleOOTBId
      - text: Show the built-in tag rule with OOTB ID {tagRuleOOTBId}.
        slots:
          tagRuleOOTBId: path.tagRuleOOTBId
      method: generated
      generated: '2026-09-26'