Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity Services TLS Service Profiles API

11 actions 11 updates phrasing extends openapi/palo-alto-networks-tls-service-profiles-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 11

$.info
$.paths['/tls-service-profiles'].get
$.paths['/tls-service-profiles'].post
$.paths['/tls-service-profiles/{id}'].get
$.paths['/tls-service-profiles/{id}'].put
$.paths['/tls-service-profiles/{id}'].delete
$.paths['/sse/config/v1/tls-service-profiles'].get
$.paths['/sse/config/v1/tls-service-profiles'].post
$.paths['/sse/config/v1/tls-service-profiles/{id}'].get
$.paths['/sse/config/v1/tls-service-profiles/{id}'].put
$.paths['/sse/config/v1/tls-service-profiles/{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 Identity Services TLS Service Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-tls-service-profiles-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: 10
- target: $.paths['/tls-service-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List TLS service profiles
      effect: read
      questions:
      - Which TLS service profiles are configured in a folder?
      - Can I search TLS service profiles by name on a device?
      instructions:
      - text: List TLS service profiles in folder {folder}.
        slots:
          folder: query.folder
      - text: Find TLS service profile {name} on device {device}.
        slots:
          name: query.name
          device: query.device
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tls-service-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a TLS service profile
      effect: write
      questions:
      - How do I create a TLS service profile with a certificate and protocol versions?
      - What does a new TLS service profile need?
      instructions:
      - text: Create TLS service profile {name} (ID {id}) with certificate {certificate} and protocol settings {protocol_settings}.
        slots:
          name: requestBody.name
          id: requestBody.id
          certificate: requestBody.certificate
          protocol_settings: requestBody.protocol_settings
      - text: Add a TLS profile {name}, ID {id}, using cert {certificate} and {protocol_settings}.
        slots:
          name: requestBody.name
          id: requestBody.id
          certificate: requestBody.certificate
          protocol_settings: requestBody.protocol_settings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tls-service-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a TLS service profile
      effect: read
      questions:
      - Which certificate and protocol versions does a TLS service profile use?
      - Can I retrieve a TLS service profile by ID?
      instructions:
      - text: Get TLS service profile {id}.
        slots:
          id: path.id
      - text: Show the certificate and protocols of TLS profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tls-service-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a TLS service profile
      effect: write
      questions:
      - Can I swap the certificate on an existing TLS service profile?
      - How do I change the minimum TLS version in a service profile?
      instructions:
      - text: Update TLS service profile {id} to certificate {certificate} with {protocol_settings}, name {name}.
        slots:
          id: path.id
          certificate: requestBody.certificate
          protocol_settings: requestBody.protocol_settings
          name: requestBody.name
      - text: Change protocol settings of TLS profile {id} ({name}) to {protocol_settings}, cert {certificate}.
        slots:
          id: path.id
          name: requestBody.name
          protocol_settings: requestBody.protocol_settings
          certificate: requestBody.certificate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tls-service-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a TLS service profile
      effect: destructive
      questions:
      - How do I remove a TLS service profile?
      - Can I delete a TLS service profile by ID?
      instructions:
      - text: Delete TLS service profile {id}.
        slots:
          id: path.id
      - text: Remove the TLS profile with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/tls-service-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List TLS service profiles
      effect: read
      questions:
      - Which TLS service profiles are configured in my folder?
      - Can I search for a TLS service profile by name?
      instructions:
      - text: List TLS service profiles in folder {folder} through the SSE config v1 path.
        slots:
          folder: query.folder
      - text: Find the TLS service profile named {name} in {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/tls-service-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a TLS service profile
      effect: write
      questions:
      - How do I create a TLS service profile that uses a specific SSL certificate?
      - What protocol settings are required for a new TLS service profile?
      instructions:
      - text: Create TLS service profile {name} in {folder} using certificate {certificate} and protocol settings {protocol_settings}.
        slots:
          name: requestBody.name
          folder: query.folder
          certificate: requestBody.certificate
          protocol_settings: requestBody.protocol_settings
      - text: Add a TLS service profile named {name} to folder {folder} with certificate {certificate} and protocols {protocol_settings}.
        slots:
          name: requestBody.name
          folder: query.folder
          certificate: requestBody.certificate
          protocol_settings: requestBody.protocol_settings
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/tls-service-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a TLS service profile by ID
      effect: read
      questions:
      - Through the SSE config v1 path, which certificate and protocol versions does a TLS service profile in a folder use?
      - Where do I view a single TLS service profile by its ID?
      instructions:
      - text: Show TLS service profile {id} in folder {folder}.
        slots:
          id: path.id
          folder: query.folder
      - text: Get the certificate assigned to TLS service profile {id} in {folder}.
        slots:
          id: path.id
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/tls-service-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a TLS service profile
      effect: write
      questions:
      - How do I make an existing TLS profile block expired or unknown certificates?
      - Can I turn on CRL or OCSP checking for a TLS service profile I already have?
      instructions:
      - text: Update TLS service profile {id} named {name} to trust CA certificates {ca_certificates}.
        slots:
          id: path.id
          name: requestBody.name
          ca_certificates: requestBody.ca_certificates
      - text: Edit TLS profile {id} ({name}, CAs {ca_certificates}) to block expired certificates and use OCSP.
        slots:
          id: path.id
          name: requestBody.name
          ca_certificates: requestBody.ca_certificates
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/tls-service-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a TLS service profile
      effect: destructive
      questions:
      - How do I remove a TLS service profile I'm no longer using?
      - Can I delete a TLS service profile by ID through the SSE config v1 path?
      instructions:
      - text: Delete TLS service profile {id} using the SSE config v1 endpoint.
        slots:
          id: path.id
      - text: Remove the old TLS service profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'