Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Security Services URL Categories API

11 actions 11 updates phrasing extends openapi/palo-alto-networks-url-categories-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['/url-categories'].get
$.paths['/url-categories'].post
$.paths['/url-categories/{id}'].get
$.paths['/url-categories/{id}'].put
$.paths['/url-categories/{id}'].delete
$.paths['/sse/config/v1/url-categories'].get
$.paths['/sse/config/v1/url-categories'].post
$.paths['/sse/config/v1/url-categories/{id}'].get
$.paths['/sse/config/v1/url-categories/{id}'].put
$.paths['/sse/config/v1/url-categories/{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 URL Categories API
  version: 1.0.0
extends: openapi/palo-alto-networks-url-categories-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['/url-categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom URL categories
      effect: read
      questions:
      - Which custom URL categories have we defined?
      - Can I filter custom URL categories by folder?
      instructions:
      - text: List custom URL categories in folder {folder}.
        slots:
          folder: query.folder
      - text: Find custom URL categories named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/url-categories'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom URL category
      effect: write
      questions:
      - How do I create a custom URL category for a list of sites?
      - Can a custom URL category match on a URL list?
      instructions:
      - text: Create custom URL category {name} with URLs {list}.
        slots:
          name: requestBody.name
          list: requestBody.list
      - text: Add URL category {name} of type {type}.
        slots:
          name: requestBody.name
          type: requestBody.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/url-categories/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom URL category
      effect: read
      questions:
      - What sites are in a particular custom URL category?
      - Can I retrieve a custom URL category by UUID?
      instructions:
      - text: Get custom URL category {id}.
        slots:
          id: path.id
      - text: Show the URL list in category {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/url-categories/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom URL category
      effect: write
      questions:
      - Can I add more sites to an existing custom URL category?
      - Is it possible to change a URL category's description?
      instructions:
      - text: Set the URLs in category {id} to {list}, name {name}.
        slots:
          id: path.id
          list: requestBody.list
          name: requestBody.name
      - text: Update URL category {id} description to {description}, name {name}.
        slots:
          id: path.id
          description: requestBody.description
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/url-categories/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom URL category
      effect: destructive
      questions:
      - How do I remove a custom URL category?
      - Can I delete a URL category by UUID?
      instructions:
      - text: Delete custom URL category {id}.
        slots:
          id: path.id
      - text: Remove URL category with UUID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/url-categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom URL categories
      effect: read
      questions:
      - Which custom URL categories exist in a Prisma Access folder?
      - Can I look up a custom URL category by name?
      instructions:
      - text: List custom URL categories in folder {folder} through the SSE config v1 endpoint.
        slots:
          folder: query.folder
      - text: Find URL category {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/url-categories'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom URL category
      effect: write
      questions:
      - How do I create a custom URL category with my own list of sites?
      - Can a custom URL category be based on a list of domains?
      instructions:
      - text: Create URL category {name} in folder {folder}.
        slots:
          name: requestBody.name
          folder: query.folder
      - text: Create URL category {name} in {folder} containing {list}.
        slots:
          name: requestBody.name
          folder: query.folder
          list: requestBody.list
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/url-categories/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a URL category
      effect: read
      questions:
      - Which URLs are in a particular custom URL category?
      - Can I fetch a URL category by its ID?
      instructions:
      - text: Get URL category {id}.
        slots:
          id: path.id
      - text: Show the URL list in category {id} through the SSE config v1 endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/url-categories/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a custom URL category
      effect: write
      questions:
      - How do I add sites to an existing custom URL category?
      - Can I change a URL category's type?
      instructions:
      - text: Replace the list in URL category {id} named {name} with {list}.
        slots:
          id: path.id
          name: requestBody.name
          list: requestBody.list
      - text: Rename URL category {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/url-categories/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom URL category
      effect: destructive
      questions:
      - How do I delete a custom URL category?
      - Can a URL category be removed if I no longer use it?
      instructions:
      - text: Delete URL category {id}.
        slots:
          id: path.id
      - text: Remove the custom URL category with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'