Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Security Services DNS Security Profiles API

11 actions 11 updates phrasing extends openapi/palo-alto-networks-dns-security-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['/dns-security-profiles'].get
$.paths['/dns-security-profiles'].post
$.paths['/dns-security-profiles/{id}'].get
$.paths['/dns-security-profiles/{id}'].put
$.paths['/dns-security-profiles/{id}'].delete
$.paths['/sse/config/v1/dns-security-profiles'].get
$.paths['/sse/config/v1/dns-security-profiles'].post
$.paths['/sse/config/v1/dns-security-profiles/{id}'].get
$.paths['/sse/config/v1/dns-security-profiles/{id}'].put
$.paths['/sse/config/v1/dns-security-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 Security Services DNS Security Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-dns-security-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['/dns-security-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List DNS security profiles
      effect: read
      questions:
      - Which DNS security profiles are configured in my Strata Cloud Manager tenant?
      - Can I list DNS security profiles from just one folder, snippet or device?
      instructions:
      - text: List all DNS security profiles.
      - text: List DNS security profiles in folder {folder}.
        slots:
          folder: query.folder
      - text: Find DNS security profiles named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dns-security-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a DNS security profile
      effect: write
      questions:
      - How do I create a new DNS security profile?
      - Can a new DNS security profile define how botnet domains are handled?
      instructions:
      - text: Create a DNS security profile named {name}.
        slots:
          name: requestBody.name
      - text: Add DNS security profile {name} with description {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      - text: Create DNS security profile {name} with botnet domain settings {botnet_domains}.
        slots:
          name: requestBody.name
          botnet_domains: requestBody.botnet_domains
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dns-security-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a DNS security profile
      effect: read
      questions:
      - What settings does a specific DNS security profile contain?
      - Can I fetch one DNS security profile by its id?
      instructions:
      - text: Get DNS security profile {id}.
        slots:
          id: path.id
      - text: Show the configuration of DNS security profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dns-security-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a DNS security profile
      effect: write
      questions:
      - How do I change botnet domain handling in an existing DNS security profile?
      - Can I rename an existing DNS security profile?
      instructions:
      - text: Rename DNS security profile {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update the description of DNS security profile {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      - text: Set botnet domain settings {botnet_domains} on DNS security profile {id}.
        slots:
          botnet_domains: requestBody.botnet_domains
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dns-security-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a DNS security profile
      effect: destructive
      questions:
      - Which call removes a DNS security profile I no longer use?
      - Is deleting a DNS security profile permanent?
      instructions:
      - text: Delete DNS security profile {id}.
        slots:
          id: path.id
      - text: Remove the DNS security profile with id {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/dns-security-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List DNS security profiles
      effect: read
      questions:
      - What DNS security profiles are configured in a folder?
      - Can I search DNS security profiles by name?
      instructions:
      - text: List DNS security profiles in folder {folder} through the SSE config v1 path.
        slots:
          folder: query.folder
      - text: Find DNS security profile {name} in {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/dns-security-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a DNS security profile
      effect: write
      questions:
      - How do I create a DNS security profile that handles botnet domains?
      - Where do I set the botnet domain policy when making a new DNS profile?
      instructions:
      - text: Create DNS security profile {name} in folder {folder}.
        slots:
          name: requestBody.name
          folder: query.folder
      - text: Add a DNS security profile in {folder} with botnet domain settings {botnet_domains}.
        slots:
          folder: query.folder
          botnet_domains: requestBody.botnet_domains
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/dns-security-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a DNS security profile
      effect: read
      questions:
      - What botnet domain actions does a specific DNS security profile use?
      - Can I retrieve one DNS security profile by ID?
      instructions:
      - text: Show DNS security profile {id}.
        slots:
          id: path.id
      - text: Get the configuration of DNS profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/dns-security-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a DNS security profile
      effect: write
      questions:
      - Can I change the botnet domain settings of an existing DNS security profile?
      - How do I update the description on a DNS security profile?
      instructions:
      - text: Update DNS security profile {id} botnet settings to {botnet_domains}.
        slots:
          id: path.id
          botnet_domains: requestBody.botnet_domains
      - text: Change the description of DNS profile {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/dns-security-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a DNS security profile
      effect: destructive
      questions:
      - Can I delete a DNS security profile?
      - What removes an unused DNS security profile?
      instructions:
      - text: Delete DNS security profile {id} using the SSE config v1 endpoint.
        slots:
          id: path.id
      - text: Remove DNS profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'