Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Prisma Cloud CI/CD API Overview CI-CD Risks API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-ci-cd-risks-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 6

$.info
$.paths['/code/code/api/v1/pipeline-risks'].post
$.paths['/code/code/api/v1/pipeline-risks/{policyId}/alerts'].post
$.paths['/code/code/api/v1/pipeline-risks/{policyId}/details'].get
$.paths['/code/code/api/v1/pipeline-risks/suppress'].put
$.paths['/code/code/api/v1/pipeline-risks/unsuppress'].put

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 CI/CD API Overview CI-CD Risks API
  version: 1.0.0
extends: openapi/palo-alto-networks-ci-cd-risks-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: 5
- target: $.paths['/code/code/api/v1/pipeline-risks'].post
  update:
    x-apievangelist-phrasing:
      intent: Summarize CI/CD pipeline risks
      effect: read
      questions:
      - What CI/CD risks exist across my repositories and pipeline systems?
      - Can I filter pipeline risks by severity and date range?
      instructions:
      - text: Summarize CI/CD risks with severities {severities}.
        slots:
          severities: requestBody.severities
      - text: List CI/CD risks for repositories {repositoryIds} between {startDate} and {endDate}.
        slots:
          repositoryIds: requestBody.repositoryIds
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/code/api/v1/pipeline-risks/{policyId}/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: List events for a CI/CD risk policy
      effect: read
      questions:
      - Which open events are raised under a specific CI/CD risk policy?
      - Can I see the suppressed or fixed events for one pipeline risk?
      instructions:
      - text: List {status} events for CI/CD risk policy {policyId}.
        slots:
          status: requestBody.status
          policyId: path.policyId
      - text: Show {status} events for policy {policyId} in repositories {repositoryIds}.
        slots:
          status: requestBody.status
          policyId: path.policyId
          repositoryIds: requestBody.repositoryIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/code/api/v1/pipeline-risks/{policyId}/details'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a CI/CD risk policy
      effect: read
      questions:
      - What does a given CI/CD risk policy check for?
      - Where can I read the full description of a pipeline risk?
      instructions:
      - text: Get the details of CI/CD risk policy {policyId}.
        slots:
          policyId: path.policyId
      - text: Explain the pipeline risk behind policy {policyId}.
        slots:
          policyId: path.policyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/code/api/v1/pipeline-risks/suppress'].put
  update:
    x-apievangelist-phrasing:
      intent: Suppress CI/CD risk events
      effect: write
      questions:
      - How do I silence CI/CD risk events I've accepted?
      - Can I suppress several pipeline risk events at once?
      instructions:
      - text: Suppress CI/CD risk events {ids}.
        slots:
          ids: requestBody.ids
      - text: Mark pipeline risk events {ids} as suppressed.
        slots:
          ids: requestBody.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/code/api/v1/pipeline-risks/unsuppress'].put
  update:
    x-apievangelist-phrasing:
      intent: Unsuppress CI/CD risk events
      effect: write
      questions:
      - Can I bring back CI/CD risk events I suppressed earlier?
      - What reopens a suppressed pipeline risk event?
      instructions:
      - text: Unsuppress CI/CD risk events {ids}.
        slots:
          ids: requestBody.ids
      - text: Restore suppressed pipeline risk events {ids}.
        slots:
          ids: requestBody.ids
      method: generated
      generated: '2026-09-26'