Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for v2 Dictionaries API

7 actions 7 updates phrasing extends openapi/palo-alto-networks-dictionaries-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 7

$.info

$.paths['/v2/api/dictionaries'].get

$.paths['/v2/api/dictionaries'].post

$.paths['/v2/api/dictionaries/{resourceId}'].get

$.paths['/v2/api/dictionaries/{resourceId}'].put

$.paths['/v2/api/dictionaries/{resourceId}'].delete

$.paths['/v2/api/dictionaries/{resourceId}'].patch

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for v2 Dictionaries API
  version: 1.0.0
extends: openapi/palo-alto-networks-dictionaries-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: 6
- target: $.paths['/v2/api/dictionaries'].get
  update:
    x-apievangelist-phrasing:
      intent: List data dictionaries
      effect: read
      questions:
      - What dictionaries have been uploaded for my tenant?
      - Can I search dictionaries by keyword and page through them?
      instructions:
      - text: List dictionaries matching keywords {keywords}.
        slots:
          keywords: query.keywords
      - text: Show page {page} of my dictionaries.
        slots:
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/dictionaries'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a new dictionary file
      effect: write
      questions:
      - How do I create a dictionary by uploading a word list file?
      - Can I add a new dictionary with its metadata in one upload?
      instructions:
      - text: Create a dictionary from file {file} with metadata {json}.
        slots:
          file: requestBody.file
          json: requestBody.json
      - text: Upload {file} as a new dictionary described by {json}.
        slots:
          file: requestBody.file
          json: requestBody.json
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/dictionaries/{resourceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dictionary
      effect: read
      questions:
      - How do I look up a single dictionary by its ID?
      - What does one dictionary contain?
      instructions:
      - text: Get dictionary {resourceId}.
        slots:
          resourceId: path.resourceId
      - text: Show the details of dictionary {resourceId}.
        slots:
          resourceId: path.resourceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/dictionaries/{resourceId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a dictionary with a new file
      effect: write
      questions:
      - Can I replace a dictionary's contents by uploading a fresh file?
      - How do I overwrite an existing dictionary with a new version?
      instructions:
      - text: Replace dictionary {resourceId} with file {file} and metadata {json}.
        slots:
          resourceId: path.resourceId
          file: requestBody.file
          json: requestBody.json
      - text: Upload {file} over dictionary {resourceId} using metadata {json}.
        slots:
          file: requestBody.file
          resourceId: path.resourceId
          json: requestBody.json
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/dictionaries/{resourceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a dictionary
      effect: destructive
      questions:
      - How do I delete a dictionary I no longer use?
      - Can I remove a dictionary by ID?
      instructions:
      - text: Delete dictionary {resourceId}.
        slots:
          resourceId: path.resourceId
      - text: Permanently remove dictionary {resourceId}.
        slots:
          resourceId: path.resourceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/dictionaries/{resourceId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a dictionary's metadata
      effect: write
      questions:
      - Can I make a dictionary case sensitive without re-uploading the file?
      - How do I change a dictionary's name or category in place?
      instructions:
      - text: Rename dictionary {resourceId} to {name} in category {category}, file {original_file_name}.
        slots:
          resourceId: path.resourceId
          name: requestBody.name
          category: requestBody.category
          original_file_name: requestBody.original_file_name
      - text: Patch dictionary {resourceId} description to {description}, keeping name {name}, category {category}, file {original_file_name}.
        slots:
          resourceId: path.resourceId
          description: requestBody.description
          name: requestBody.name
          category: requestBody.category
          original_file_name: requestBody.original_file_name
      method: generated
      generated: '2026-09-26'