Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Network Services Link Tags API

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

$.info
$.paths['/link-tags'].get
$.paths['/link-tags'].post
$.paths['/link-tags/{id}'].get
$.paths['/link-tags/{id}'].put
$.paths['/link-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 Network Services Link Tags API
  version: 1.0.0
extends: openapi/palo-alto-networks-link-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: 5
- target: $.paths['/link-tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List link tags
      effect: read
      questions:
      - Which link tags are defined for my SD-WAN links?
      - Can I filter link tags by folder or device?
      instructions:
      - text: List all link tags.
      - text: List link tags in folder {folder}.
        slots:
          folder: query.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/link-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a link tag
      effect: write
      questions:
      - How do I create a new link tag with a color?
      - Can I add comments when creating a link tag?
      instructions:
      - text: Create link tag {name} with color {color}.
        slots:
          name: requestBody.name
          color: requestBody.color
      - text: Add a new link tag named {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/link-tags/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a link tag
      effect: read
      questions:
      - What color and comments does one link tag have?
      - Can I fetch a link tag by ID?
      instructions:
      - text: Get link tag {id}.
        slots:
          id: path.id
      - text: Show the details of link tag {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/link-tags/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a link tag
      effect: write
      questions:
      - How do I change an existing link tag's color?
      - Can I rename a link tag?
      instructions:
      - text: Change the color of link tag {id} to {color}.
        slots:
          id: path.id
          color: requestBody.color
      - text: Rename link tag {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/link-tags/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a link tag
      effect: destructive
      questions:
      - How do I remove a link tag?
      - Is deleting a link tag by ID permanent?
      instructions:
      - text: Delete link tag {id}.
        slots:
          id: path.id
      - text: Remove the link tag {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'