Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for TLS Protect Cloud API for Strata Cloud Manager Certificate…

7 actions 7 updates phrasing extends openapi/palo-alto-networks-certificate-request-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['/outagedetection/v1/certificaterequests'].get
$.paths['/outagedetection/v1/certificaterequests'].post
$.paths['/outagedetection/v1/certificaterequests/{id}'].get
$.paths['/outagedetection/v1/certificaterequests/{id}/resubmission'].post
$.paths['/outagedetection/v1/certificaterequests/validation'].post
$.paths['/outagedetection/v1/certificaterequestssearch'].post

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 TLS Protect Cloud API for Strata Cloud Manager Certificate…
  version: 1.0.0
extends: openapi/palo-alto-networks-certificate-request-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['/outagedetection/v1/certificaterequests'].get
  update:
    x-apievangelist-phrasing:
      intent: List all certificate requests
      effect: read
      questions:
      - What certificate requests have been made so far?
      - Can I see every certificate request without writing a search expression?
      instructions:
      - text: List all certificate requests.
      - text: Show the details of every certificate request.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/outagedetection/v1/certificaterequests'].post
  update:
    x-apievangelist-phrasing:
      intent: Request a new or renewed certificate
      effect: write
      questions:
      - How do I request a certificate for an application using an issuing template?
      - Can I renew an existing certificate by pointing a new request at it?
      - Can I submit my own CSR instead of having one generated?
      instructions:
      - text: Request a certificate for application {applicationId} using issuing template {templateId} (generated CSR {isVaaSGenerated}).
        slots:
          applicationId: requestBody.applicationId
          templateId: requestBody.certificateIssuingTemplateId
          isVaaSGenerated: requestBody.isVaaSGenerated
      - text: Renew certificate {existingCertificateId} for application {applicationId} with template {templateId}, generated CSR {isVaaSGenerated}.
        slots:
          existingCertificateId: requestBody.existingCertificateId
          applicationId: requestBody.applicationId
          templateId: requestBody.certificateIssuingTemplateId
          isVaaSGenerated: requestBody.isVaaSGenerated
      method: generated
      generated: '2026-09-26'
- target: $.paths['/outagedetection/v1/certificaterequests/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a certificate request's details
      effect: read
      questions:
      - What's the status of a certificate request I submitted?
      - Can I look up one certificate request by its ID?
      instructions:
      - text: Get certificate request {id}.
        slots:
          id: path.id
      - text: Show the status of certificate request {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/outagedetection/v1/certificaterequests/{id}/resubmission'].post
  update:
    x-apievangelist-phrasing:
      intent: Resubmit a certificate request
      effect: write
      questions:
      - Can I retry a certificate request that failed?
      - Is it possible to resubmit a request with a different validity period?
      instructions:
      - text: Resubmit certificate request {id}.
        slots:
          id: path.id
      - text: Resubmit request {id} with validity period {validityPeriod}.
        slots:
          id: path.id
          validityPeriod: requestBody.validityPeriod
      method: generated
      generated: '2026-09-26'
- target: $.paths['/outagedetection/v1/certificaterequests/validation'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a certificate request before submitting
      effect: read
      questions:
      - Can I test whether a certificate request complies with the issuing template without submitting it?
      - Does a dry-run check tell me if my CSR attributes are acceptable?
      instructions:
      - text: Validate a certificate request for application {applicationId} against template {templateId} without submitting it (generated CSR {isVaaSGenerated}).
        slots:
          applicationId: requestBody.applicationId
          templateId: requestBody.certificateIssuingTemplateId
          isVaaSGenerated: requestBody.isVaaSGenerated
      - text: Dry-run a certificate request with CSR attributes {csrAttributes} for application {applicationId}, template {templateId}, generated {isVaaSGenerated}.
        slots:
          csrAttributes: requestBody.csrAttributes
          applicationId: requestBody.applicationId
          templateId: requestBody.certificateIssuingTemplateId
          isVaaSGenerated: requestBody.isVaaSGenerated
      method: generated
      generated: '2026-09-26'
- target: $.paths['/outagedetection/v1/certificaterequestssearch'].post
  update:
    x-apievangelist-phrasing:
      intent: Search certificate requests
      effect: read
      questions:
      - Can I search certificate requests with a filter expression and sort order?
      - Which certificate requests match a given status or application?
      instructions:
      - text: Search certificate requests matching {expression}.
        slots:
          expression: requestBody.expression
      - text: Find certificate requests matching {expression} ordered by {ordering}.
        slots:
          expression: requestBody.expression
          ordering: requestBody.ordering
      method: generated
      generated: '2026-09-26'