Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for TLS Protect Cloud API for Strata Cloud Manager Certificate…

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

$.info
$.paths['/v1/tags'].get
$.paths['/v1/tags'].post
$.paths['/v1/tags/{name}'].get
$.paths['/v1/tags/{name}'].delete
$.paths['/v1/tags/{name}/values'].get
$.paths['/v1/tags/{name}/values'].post
$.paths['/v1/tags/{name}/values/{value}'].delete
$.paths['/v1/tags/values'].get
$.paths['/v1/tags/creation'].post
$.paths['/v1/tags/deletion'].post
$.paths['/v1/tagsassignment'].patch
$.paths['/v1/tagsassignment/aggregates'].post

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 TLS Protect Cloud API for Strata Cloud Manager Certificate…
  version: 1.0.0
extends: openapi/palo-alto-networks-certificate-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: 12
- target: $.paths['/v1/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List all tags
      effect: read
      questions:
      - What tags have been defined for my certificates so far?
      - Can I see the details of every available tag in one call?
      instructions:
      - text: List every tag I have defined.
      - text: Show the details of all available tags.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a tag
      effect: write
      questions:
      - How do I create a new tag, optionally with some starting values?
      - Can I define a single tag like environment with values prod and dev at creation time?
      instructions:
      - text: Create a tag named {name}.
        slots:
          name: requestBody.name
      - text: Create tag {name} with initial values {values}.
        slots:
          name: requestBody.name
          values: requestBody.values
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tags/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tag by name
      effect: read
      questions:
      - What does the tag called owner look like, looked up by its name?
      - Can I fetch a single tag's definition if I know its name?
      instructions:
      - text: Get the tag named {name}.
        slots:
          name: path.name
      - text: Show me the definition of tag {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tags/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tag by name
      effect: destructive
      questions:
      - How do I remove a tag I no longer use?
      - Can I delete one tag entirely by referring to its name?
      instructions:
      - text: Delete the tag named {name}.
        slots:
          name: path.name
      - text: Remove tag {name} completely.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tags/{name}/values'].get
  update:
    x-apievangelist-phrasing:
      intent: List the values of one tag
      effect: read
      questions:
      - Which values are allowed for a particular tag?
      - Can I see just the values defined under one tag?
      instructions:
      - text: List the values of tag {name}.
        slots:
          name: path.name
      - text: Show every value defined under tag {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tags/{name}/values'].post
  update:
    x-apievangelist-phrasing:
      intent: Add values to an existing tag
      effect: write
      questions:
      - Can I add new values to a tag that already exists?
      - What's the way to extend an existing tag with extra values like staging?
      instructions:
      - text: Add values {values} to tag {name}.
        slots:
          values: requestBody.values
          name: path.name
      - text: Extend existing tag {name} with the values {values}.
        slots:
          name: path.name
          values: requestBody.values
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tags/{name}/values/{value}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one value from a tag
      effect: destructive
      questions:
      - How do I remove a single value from a tag without deleting the tag?
      - Can I drop an obsolete value from one of my tags?
      instructions:
      - text: Delete value {value} from tag {name}.
        slots:
          value: path.value
          name: path.name
      - text: Remove the {value} option from tag {name}.
        slots:
          value: path.value
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tags/values'].get
  update:
    x-apievangelist-phrasing:
      intent: List values across all tags
      effect: read
      questions:
      - What values exist across every tag at once?
      - Can I get the full list of tag values for all tags in one request?
      instructions:
      - text: List the values of every tag.
      - text: Show all tag values across all my tags.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tags/creation'].post
  update:
    x-apievangelist-phrasing:
      intent: Create many tags at once
      effect: write
      questions:
      - Can I create a whole batch of tags in one request?
      - Is there a bulk option to set up many tags with their values at the same time?
      instructions:
      - text: 'Create these tags in bulk: {tags}.'
        slots:
          tags: requestBody.tags
      - text: Bulk-create the tag set {tags} with their values.
        slots:
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tags/deletion'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete many tags or values at once
      effect: destructive
      questions:
      - Can I delete several tags and tag values in a single call?
      - What's the bulk way to clean up a batch of tag keys and values?
      instructions:
      - text: Bulk-delete the tags and values {tags}.
        slots:
          tags: requestBody.tags
      - text: 'Remove this batch of tag keys in one go: {tags}.'
        slots:
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tagsassignment'].patch
  update:
    x-apievangelist-phrasing:
      intent: Assign or remove tags on entities
      effect: write
      questions:
      - How do I apply a tag to a set of certificates?
      - Can I replace, add or remove tags on several entities at once?
      instructions:
      - text: Add tags {tags} to entities {entity_ids}.
        slots:
          tags: requestBody.targetedTags
          entity_ids: requestBody.entityIds
      - text: Apply tag action {action} with tags {tags} to {entity_type} entities {entity_ids}.
        slots:
          action: requestBody.action
          tags: requestBody.targetedTags
          entity_type: requestBody.entityType
          entity_ids: requestBody.entityIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tagsassignment/aggregates'].post
  update:
    x-apievangelist-phrasing:
      intent: Count entities carrying each tag
      effect: read
      questions:
      - How many entities are assigned each of these tags?
      - Can I get per-tag entity counts for a given entity type?
      instructions:
      - text: Count how many entities carry each of tags {tags}.
        slots:
          tags: requestBody.tags
      - text: Show the number of {entity_type} entities per tag for {tags}.
        slots:
          entity_type: requestBody.entityType
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'