Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Management OCSP Responder API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-ocspresponder-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['/sse/config/v1/ocsp-responder'].get
$.paths['/sse/config/v1/ocsp-responder'].post
$.paths['/sse/config/v1/ocsp-responder/{id}'].get
$.paths['/sse/config/v1/ocsp-responder/{id}'].put
$.paths['/sse/config/v1/ocsp-responder/{id}'].delete

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 Management OCSP Responder API
  version: 1.0.0
extends: openapi/palo-alto-networks-ocspresponder-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['/sse/config/v1/ocsp-responder'].get
  update:
    x-apievangelist-phrasing:
      intent: List OCSP responders
      effect: read
      questions:
      - Which OCSP responders are configured for certificate revocation checks?
      - Can I look up an OCSP responder by name in a given folder?
      instructions:
      - text: List OCSP responders in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the OCSP responder named {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      - text: Show {limit} OCSP responders from {folder} starting at offset {offset}.
        slots:
          limit: query.limit
          folder: query.folder
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/ocsp-responder'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an OCSP responder
      effect: write
      questions:
      - How do I add a new OCSP responder hostname for checking certificate status?
      - What name characters are allowed for a new OCSP responder?
      instructions:
      - text: Create an OCSP responder named {name} at host {host_name} in folder {folder}.
        slots:
          name: requestBody.name
          host_name: requestBody.host_name
          folder: query.folder
      - text: Add OCSP responder {name} pointing to {host_name} under {folder}.
        slots:
          name: requestBody.name
          host_name: requestBody.host_name
          folder: query.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/ocsp-responder/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an OCSP responder by ID
      effect: read
      questions:
      - What hostname is a specific OCSP responder using?
      - Where do I view a single OCSP responder's details by ID?
      instructions:
      - text: Show OCSP responder {id}.
        slots:
          id: path.id
      - text: Get the host name configured on OCSP responder {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/ocsp-responder/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit an OCSP responder
      effect: write
      questions:
      - How do I change the hostname of an OCSP responder I already set up?
      - Can I rename an existing OCSP responder?
      instructions:
      - text: Change OCSP responder {id} to use host {host_name}.
        slots:
          id: path.id
          host_name: requestBody.host_name
      - text: Update OCSP responder {id} with name {name} and host {host_name}.
        slots:
          id: path.id
          name: requestBody.name
          host_name: requestBody.host_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/ocsp-responder/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an OCSP responder
      effect: destructive
      questions:
      - How do I remove an OCSP responder that's no longer in service?
      - Can I delete an OCSP responder using its ID?
      instructions:
      - text: Delete OCSP responder {id}.
        slots:
          id: path.id
      - text: Remove the retired OCSP responder {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'