Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Tags API

23 actions 23 updates phrasing extends openapi/palo-alto-networks-tags-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 23 · first 16 shown; the file carries all of them

$.info
$.paths['/sse/config/v1/tags'].get
$.paths['/sse/config/v1/tags'].post
$.paths['/sse/config/v1/tags/{id}'].get
$.paths['/sse/config/v1/tags/{id}'].put
$.paths['/sse/config/v1/tags/{id}'].delete
$.paths['/api/v34.03/tags'].get
$.paths['/api/v34.03/tags'].post
$.paths['/api/v34.03/tags/{id}'].put
$.paths['/api/v34.03/tags/{id}'].delete
$.paths['/api/v34.03/tags/{id}/vuln'].post
$.paths['/api/v34.03/tags/{id}/vuln'].delete
$.paths['/api/v34.04/tags'].get
$.paths['/api/v34.04/tags'].post
$.paths['/api/v34.04/tags/{id}'].put
$.paths['/api/v34.04/tags/{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 Palo Alto Networks Tags API
  version: 1.0.0
extends: openapi/palo-alto-networks-tags-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: 22
- target: $.paths['/sse/config/v1/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List SSE config tags in a folder
      effect: read
      questions:
      - Which tags are defined in my Shared SSE configuration folder?
      - Can I page through the SSE config tags in a folder with limit and offset?
      - Is there a way to look up an SSE configuration tag by its name within one folder?
      instructions:
      - text: List the SSE configuration tags in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the SSE config tag named {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      - text: Show {limit} SSE config tags from folder {folder}, skipping the first {offset}.
        slots:
          limit: query.limit
          folder: query.folder
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an SSE config tag in a folder
      effect: write
      questions:
      - How do I add a new tag to an SSE configuration folder?
      - Can I set a color and comments when creating an SSE config tag?
      instructions:
      - text: Create an SSE configuration tag named {name} in folder {folder}.
        slots:
          name: requestBody.name
          folder: query.folder
      - text: Add SSE config tag {name} to folder {folder} with color {color} and comment {comments}.
        slots:
          name: requestBody.name
          folder: query.folder
          color: requestBody.color
          comments: requestBody.comments
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/tags/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an SSE config tag by ID
      effect: read
      questions:
      - How can I see the color and comments of one SSE configuration tag by its UUID?
      - What details come back for a single tag in the SSE config API?
      instructions:
      - text: Fetch SSE configuration tag {id}.
        slots:
          id: path.id
      - text: Show me the name, color and comments of SSE config tag {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/tags/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit an SSE config tag
      effect: write
      questions:
      - Can I rename or recolor an existing SSE configuration tag?
      - How do I change the comments on an SSE config tag I already created?
      instructions:
      - text: Rename SSE configuration tag {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Change the color of SSE config tag {id} ({name}) to {color}.
        slots:
          id: path.id
          name: requestBody.name
          color: requestBody.color
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/tags/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an SSE config tag
      effect: destructive
      questions:
      - How do I remove a tag from my SSE configuration?
      - Can I delete an SSE config tag by its UUID?
      instructions:
      - text: Delete SSE configuration tag {id}.
        slots:
          id: path.id
      - text: Remove the SSE config tag with UUID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List vulnerability tags (Compute v34.03)
      effect: read
      questions:
      - Which vulnerability tags exist in Compute on the v34.03 API?
      - Can I pull every CVE tag through the older v34.03 tags endpoint?
      instructions:
      - text: List all vulnerability tags using the v34.03 Compute API.
      - text: Get the v34.03 tag list with each tag's tagged CVEs.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a vulnerability tag (Compute v34.03)
      effect: write
      questions:
      - How do I create a vulnerability tag via the v34.03 Compute API?
      - Can a new v34.03 tag carry a hex color and description?
      instructions:
      - text: Add a v34.03 Compute tag named {name}.
        slots:
          name: requestBody.name
      - text: On API v34.03, create tag {name} with color {color} and description {description}.
        slots:
          name: requestBody.name
          color: requestBody.color
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/tags/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a vulnerability tag (Compute v34.03)
      effect: write
      questions:
      - Can I change a Compute tag's description through the v34.03 API?
      - Is it possible to replace the tagged vulnerabilities on a tag using v34.03?
      instructions:
      - text: Update v34.03 Compute tag {id} with description {description}.
        slots:
          id: path.id
          description: requestBody.description
      - text: Using the v34.03 API, recolor tag {id} to {color}.
        slots:
          id: path.id
          color: requestBody.color
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/tags/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a vulnerability tag (Compute v34.03)
      effect: destructive
      questions:
      - How do I delete a whole Compute tag through the v34.03 API?
      - Does v34.03 let me remove a tag entirely, not just its CVE entries?
      instructions:
      - text: Delete Compute tag {id} via API v34.03.
        slots:
          id: path.id
      - text: Remove the entire v34.03 tag {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/tags/{id}/vuln'].post
  update:
    x-apievangelist-phrasing:
      intent: Tag a CVE with vulnerability metadata (v34.03)
      effect: write
      questions:
      - How do I attach a CVE to a tag with the v34.03 Compute API?
      - Can I scope a v34.03 tag's CVE to specific images or hosts by resource type?
      - Is there a v34.03 option to check the base layer when tagging an image vulnerability?
      instructions:
      - text: Using v34.03, tag CVE {cve} on tag {id} for package {packageName}.
        slots:
          cve: requestBody.id
          id: path.id
          packageName: requestBody.packageName
      - text: 'Set v34.03 vulnerability metadata on tag {id}: CVE {cve}, resource type {resourceType}, resources {resources}.'
        slots:
          id: path.id
          cve: requestBody.id
          resourceType: requestBody.resourceType
          resources: requestBody.resources
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/tags/{id}/vuln'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear a tag's vulnerability metadata (v34.03)
      effect: destructive
      questions:
      - How do I strip the CVE metadata from a tag while keeping the tag, on v34.03?
      - Can the v34.03 API remove vulnerability metadata from one tag?
      instructions:
      - text: Delete the vulnerability metadata from tag {id} using v34.03.
        slots:
          id: path.id
      - text: Clear v34.03 CVE entries on tag {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List vulnerability tags (Compute v34.04)
      effect: read
      questions:
      - What tags are defined in Compute on the current v34.04 API?
      - Which CVEs are tagged across my tags in v34.04?
      instructions:
      - text: Retrieve every tag from the v34.04 Compute tags endpoint.
      - text: Show v34.04 tags along with their vulnerabilities.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a vulnerability tag (Compute v34.04)
      effect: write
      questions:
      - How do I add a new Compute tag on API version 34.04?
      - Can I include tagged vulns when creating a tag on v34.04?
      instructions:
      - text: Create Compute tag {name} on the v34.04 API.
        slots:
          name: requestBody.name
      - text: With v34.04, add tag {name} described as {description} and tagged vulns {vulns}.
        slots:
          name: requestBody.name
          description: requestBody.description
          vulns: requestBody.vulns
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/tags/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a vulnerability tag (Compute v34.04)
      effect: write
      questions:
      - How do I rename a Compute tag using the v34.04 API?
      - Can v34.04 overwrite the vulns list on an existing tag?
      instructions:
      - text: Rename tag {id} to {name} with the v34.04 API.
        slots:
          id: path.id
          name: requestBody.name
      - text: On v34.04, replace the vulnerabilities on tag {id} with {vulns}.
        slots:
          id: path.id
          vulns: requestBody.vulns
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/tags/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a vulnerability tag (Compute v34.04)
      effect: destructive
      questions:
      - Can I permanently drop a Compute tag through version 34.04?
      - What happens to a tag deleted on the v34.04 tags endpoint?
      instructions:
      - text: Delete tag {id} using the v34.04 Compute API.
        slots:
          id: path.id
      - text: Drop Compute tag {id} (v34.04).
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/tags/{id}/vuln'].post
  update:
    x-apievangelist-phrasing:
      intent: Tag a CVE with vulnerability metadata (v34.04)
      effect: write
      questions:
      - How do I add a CVE with a comment to a Compute tag on v34.04?
      - Can I limit a CVE tag to certain functions or images on the v34.04 API?
      instructions:
      - text: On v34.04, set CVE {cve} on tag {id} with comment {comment}.
        slots:
          cve: requestBody.id
          id: path.id
          comment: requestBody.comment
      - text: Attach CVE {cve} in package {packageName} to v34.04 tag {id}, checking the image base layer.
        slots:
          cve: requestBody.id
          packageName: requestBody.packageName
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/tags/{id}/vuln'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear a tag's vulnerability metadata (v34.04)
      effect: destructive
      questions:
      - How do I remove all CVE assignments from a tag using the v34.04 API?
      - Does deleting vuln metadata on v34.04 keep the tag itself?
      instructions:
      - text: With v34.04, remove vulnerability metadata from tag {id}.
        slots:
          id: path.id
      - text: Wipe the tagged CVEs on tag {id} through the v34.04 vuln endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List Strata Cloud Manager config tags
      effect: read
      questions:
      - Which configuration tags are defined in a snippet or on a device?
      - Can I filter the configuration tag list by folder, snippet or device?
      instructions:
      - text: List the configuration tags in snippet {snippet}.
        slots:
          snippet: query.snippet
      - text: Show the configuration tags defined on device {device}.
        slots:
          device: query.device
      - text: Look up configuration tag {name} across folders, snippets and devices.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a configuration tag
      effect: write
      questions:
      - How do I create a configuration tag for my security policy objects?
      - What fields besides name can a new configuration tag have?
      instructions:
      - text: Create configuration tag {name}.
        slots:
          name: requestBody.name
      - text: Make a new configuration tag {name}, color {color}, described as {comments}.
        slots:
          name: requestBody.name
          color: requestBody.color
          comments: requestBody.comments
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tags/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a configuration tag
      effect: read
      questions:
      - How do I fetch one configuration tag by UUID, whatever folder or snippet holds it?
      - What does a single configuration tag record include?
      instructions:
      - text: Get configuration tag {id}.
        slots:
          id: path.id
      - text: Pull up the existing configuration tag with UUID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tags/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a configuration tag
      effect: write
      questions:
      - Can I update the description of an existing configuration tag?
      - Is the tag name required when I update a configuration tag?
      instructions:
      - text: Update configuration tag {id} to name {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set the description of configuration tag {id} ({name}) to {comments}.
        slots:
          id: path.id
          name: requestBody.name
          comments: requestBody.comments
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tags/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a configuration tag
      effect: destructive
      questions:
      - How do I remove a configuration tag that's no longer used?
      - Can a configuration tag be deleted by its UUID?
      instructions:
      - text: Delete configuration tag {id}.
        slots:
          id: path.id
      - text: Get rid of the configuration tag with UUID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'