Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Manage Custom URL Categories API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-managecustomurlcategories-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/config/rulestacks/{rulestackname}/urlcustomcategories'].get
$.paths['/v1/config/rulestacks/{rulestackname}/urlcustomcategories'].post
$.paths['/v1/config/rulestacks/{rulestackname}/urlcustomcategories/{name}'].get
$.paths['/v1/config/rulestacks/{rulestackname}/urlcustomcategories/{name}'].put
$.paths['/v1/config/rulestacks/{rulestackname}/urlcustomcategories/{name}'].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 Manage Custom URL Categories API
  version: 1.0.0
extends: openapi/palo-alto-networks-managecustomurlcategories-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/config/rulestacks/{rulestackname}/urlcustomcategories'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom URL categories in a rulestack
      effect: read
      questions:
      - Which custom URL categories are defined in a cloud NGFW rulestack?
      - Can I see only the running or only the candidate custom URL categories?
      instructions:
      - text: List custom URL categories in rulestack {rulestackname}.
        slots:
          rulestackname: path.rulestackname
      - text: Show up to {maxresults} custom URL categories in {rulestackname}.
        slots:
          maxresults: query.maxresults
          rulestackname: path.rulestackname
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/rulestacks/{rulestackname}/urlcustomcategories'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom URL category
      effect: write
      questions:
      - How do I create a custom URL category to allow exceptions to URL filtering?
      - Can I group several URLs into one custom category with its own action?
      instructions:
      - text: Create URL category {Name} in rulestack {rulestackname} with URLs {UrlTargets}.
        slots:
          Name: requestBody.Name
          rulestackname: path.rulestackname
          UrlTargets: requestBody.UrlTargets
      - text: Add custom category {Name} to {rulestackname} for {UrlTargets} with action {Action}.
        slots:
          Name: requestBody.Name
          rulestackname: path.rulestackname
          UrlTargets: requestBody.UrlTargets
          Action: requestBody.Action
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/rulestacks/{rulestackname}/urlcustomcategories/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom URL category
      effect: read
      questions:
      - What URLs and action are set on a specific custom URL category?
      - Can I read a predefined URL category the same way as a custom one?
      instructions:
      - text: Get URL category {name} in rulestack {rulestackname}.
        slots:
          name: path.name
          rulestackname: path.rulestackname
      - text: Show the running version of category {name} in {rulestackname}.
        slots:
          name: path.name
          rulestackname: path.rulestackname
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/rulestacks/{rulestackname}/urlcustomcategories/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom URL category
      effect: write
      questions:
      - How do I change the URLs in an existing custom URL category?
      - Can I leave an audit comment when modifying a URL category?
      instructions:
      - text: Update category {name} in {rulestackname} to URLs {UrlTargets}.
        slots:
          name: path.name
          rulestackname: path.rulestackname
          UrlTargets: requestBody.UrlTargets
      - text: Change {name} in rulestack {rulestackname} to {UrlTargets} with comment {AuditComment}.
        slots:
          name: path.name
          rulestackname: path.rulestackname
          UrlTargets: requestBody.UrlTargets
          AuditComment: requestBody.AuditComment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/rulestacks/{rulestackname}/urlcustomcategories/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom URL category
      effect: destructive
      questions:
      - How do I delete a custom URL category from a rulestack?
      - Can I remove a URL category I created earlier?
      instructions:
      - text: Delete URL category {name} from rulestack {rulestackname}.
        slots:
          name: path.name
          rulestackname: path.rulestackname
      - text: Remove custom category {name} in {rulestackname}.
        slots:
          name: path.name
          rulestackname: path.rulestackname
      method: generated
      generated: '2026-09-26'