Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal - Admin Management Policy Tag API

6 actions 6 updates phrasing extends openapi/strivacity-policy-tag-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Strivacity's API. It is a proposal applied on top of the contract, not a document Strivacity publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/admin/api/v1/admin/policyTags'].get
$.paths['/admin/api/v1/admin/policyTags'].post
$.paths['/admin/api/v1/admin/policyTags/{name}'].get
$.paths['/admin/api/v1/admin/policyTags/{name}'].put
$.paths['/admin/api/v1/admin/policyTags/{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 Admin Portal - Admin Management Policy Tag API
  version: 1.0.0
extends: openapi/strivacity-policy-tag-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/admin/api/v1/admin/policyTags'].get
  update:
    x-apievangelist-phrasing:
      intent: List policy tags
      effect: read
      questions:
      - Which policy tags are available to label my policies?
      - Can I search policy tags by name?
      instructions:
      - text: List all policy tags.
      - text: Search policy tags for {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/policyTags'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a policy tag
      effect: write
      questions:
      - How do I create a colored tag to group related policies?
      - Can a policy tag have a description?
      instructions:
      - text: Create a policy tag named {name} with color {color}.
        slots:
          name: requestBody.name
          color: requestBody.color
      - text: Add policy tag {name} in {color} described as {description}.
        slots:
          name: requestBody.name
          color: requestBody.color
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/policyTags/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a policy tag
      effect: read
      questions:
      - How do I look up the color and description of one policy tag?
      - What does a specific policy tag look like?
      instructions:
      - text: Show policy tag {name}.
        slots:
          name: path.name
      - text: Get the details of the {name} tag.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/policyTags/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a policy tag
      effect: write
      questions:
      - How do I change the color of an existing policy tag?
      - Can a policy tag be renamed?
      instructions:
      - text: Change policy tag {name} to color {color}.
        slots:
          name: path.name
          color: requestBody.color
      - text: Update the description of existing tag {name} to {description}.
        slots:
          name: path.name
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/policyTags/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a policy tag
      effect: destructive
      questions:
      - Why can't I delete a policy tag that is still assigned?
      - How do I remove an unused policy tag?
      instructions:
      - text: Delete policy tag {name}.
        slots:
          name: path.name
      - text: Remove the unassigned tag {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'