Palo Alto Networks · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/palo-alto-networks-certificate-discovery-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['/v1/integrationservices'].get

$.paths['/v1/integrationservices'].post

$.paths['/v1/integrationservices/{id}'].get

$.paths['/v1/integrationservices/{id}'].delete

$.paths['/v1/integrationservices/{id}'].patch

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 TLS Protect Cloud API for Strata Cloud Manager Certificate…
  version: 1.0.0
extends: openapi/palo-alto-networks-certificate-discovery-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['/v1/integrationservices'].get
  update:
    x-apievangelist-phrasing:
      intent: List certificate discovery services
      effect: read
      questions:
      - Which discovery and key pair services are set up for certificate management?
      - Can I list only the services tied to one VSatellite instance?
      instructions:
      - text: List all integration services.
      - text: Show integration services on VSatellite instance {edgeInstanceId}.
        slots:
          edgeInstanceId: query.edgeInstanceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/integrationservices'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a certificate discovery service
      effect: write
      questions:
      - How do I set up a new certificate discovery service?
      - Can I schedule a discovery service to run automatically?
      instructions:
      - text: Add service {name} of type {serviceType} in environment {environmentId} with work types {workTypes}.
        slots:
          name: requestBody.name
          serviceType: requestBody.serviceType
          environmentId: requestBody.environmentId
          workTypes: requestBody.workTypes
      - text: Create scheduled service {name}, type {serviceType}, environment {environmentId}, work {workTypes}, pattern {schedulePattern}.
        slots:
          name: requestBody.name
          serviceType: requestBody.serviceType
          environmentId: requestBody.environmentId
          workTypes: requestBody.workTypes
          schedulePattern: requestBody.schedulePattern
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/integrationservices/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a certificate discovery service
      effect: read
      questions:
      - What targets and schedule does one discovery service have?
      - Can I see the details of an integration service by ID?
      instructions:
      - text: Get integration service {id}.
        slots:
          id: path.id
      - text: Show targets and schedule for service {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/integrationservices/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a certificate discovery service
      effect: destructive
      questions:
      - How do I delete a discovery service?
      - Can I retire the certificates a service found when I remove it?
      instructions:
      - text: Delete integration service {id}.
        slots:
          id: path.id
      - text: Remove service {id} and set retireCertificates to {retireCertificates}.
        slots:
          id: path.id
          retireCertificates: query.retireCertificates
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/integrationservices/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a certificate discovery service
      effect: write
      questions:
      - How do I change the schedule of an existing discovery service?
      - Can I clear the VSatellite instances assigned to a service?
      instructions:
      - text: Set the schedule of service {id} to {schedulePattern}.
        slots:
          id: path.id
          schedulePattern: requestBody.schedulePattern
      - text: Set scheduled execution to {scheduleEnabled} for integration service {id}.
        slots:
          scheduleEnabled: requestBody.scheduleEnabled
          id: path.id
      method: generated
      generated: '2026-09-26'