Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal - Admin Management Tag Based Permission API

6 actions 6 updates phrasing extends openapi/strivacity-tag-based-permission-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/identityStore/roles/{roleId}/tagBasedPermissions'].get
$.paths['/admin/api/v1/admin/identityStore/roles/{roleId}/tagBasedPermissions'].post
$.paths['/admin/api/v1/admin/identityStore/roles/{roleId}/tagBasedPermissions/{id}'].get
$.paths['/admin/api/v1/admin/identityStore/roles/{roleId}/tagBasedPermissions/{id}'].put
$.paths['/admin/api/v1/admin/identityStore/roles/{roleId}/tagBasedPermissions/{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 Admin Portal - Admin Management Tag Based Permission API
  version: 1.0.0
extends: openapi/strivacity-tag-based-permission-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/identityStore/roles/{roleId}/tagBasedPermissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List an admin role's tag based permissions
      effect: read
      questions:
      - Which policy tags can an admin role manage?
      - Can I filter an admin role's tag based permissions by policy tag?
      instructions:
      - text: List tag based permissions for admin role {roleId}.
        slots:
          roleId: path.roleId
      - text: List admin role {roleId} permissions for tags {policyTags}.
        slots:
          roleId: path.roleId
          policyTags: query.policyTags
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/roles/{roleId}/tagBasedPermissions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create tag based permissions for an admin role
      effect: write
      questions:
      - How do I let an admin role manage only policies with certain tags?
      - Can I scope admin permissions by policy tag?
      instructions:
      - text: Grant admin role {roleId} scopes {scopes} on policy tags {policyTags}.
        slots:
          roleId: path.roleId
          scopes: requestBody.scopes
          policyTags: requestBody.policyTags
      - text: Create a tag based permission for role {roleId} covering tags {policyTags} with scopes {scopes}.
        slots:
          roleId: path.roleId
          policyTags: requestBody.policyTags
          scopes: requestBody.scopes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/roles/{roleId}/tagBasedPermissions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tag based permission entry
      effect: read
      questions:
      - Can I view one tag based permission entry on an admin role?
      - What scopes does a specific tag permission grant?
      instructions:
      - text: Get tag based permission {id} of admin role {roleId}.
        slots:
          id: path.id
          roleId: path.roleId
      - text: Show admin role {roleId} tag permission entry {id}.
        slots:
          id: path.id
          roleId: path.roleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/roles/{roleId}/tagBasedPermissions/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a tag based permission entry
      effect: write
      questions:
      - How do I change the tags or scopes of an admin role's tag permission?
      - Can I widen a tag based permission to more policy tags?
      instructions:
      - text: Update tag permission {id} on role {roleId} to tags {policyTags} and scopes {scopes}.
        slots:
          id: path.id
          roleId: path.roleId
          policyTags: requestBody.policyTags
          scopes: requestBody.scopes
      - text: Change the scopes of admin role {roleId} tag permission {id} to {scopes} for tags {policyTags}.
        slots:
          roleId: path.roleId
          id: path.id
          scopes: requestBody.scopes
          policyTags: requestBody.policyTags
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/roles/{roleId}/tagBasedPermissions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tag based permission entry
      effect: destructive
      questions:
      - How do I remove a tag based permission from an admin role?
      - Can I revoke an admin role's access to a policy tag?
      instructions:
      - text: Delete tag based permission {id} from admin role {roleId}.
        slots:
          id: path.id
          roleId: path.roleId
      - text: Remove admin role {roleId}'s tag permission entry {id}.
        slots:
          id: path.id
          roleId: path.roleId
      method: generated
      generated: '2026-10-01'