API Evangelist conversational phrasing for Admin Portal - Admin Management Admin Role API

# 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 Admin Role API
  version: 1.0.0
extends: openapi/strivacity-admin-role-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: 6
- target: $.paths['/admin/api/v1/admin/identityStore/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List admin roles
      effect: read
      questions:
      - Which admin roles are defined for the admin portal?
      - Can I search admin roles by name?
      instructions:
      - text: List all admin roles.
      - text: Find the admin role named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/roles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an admin role
      effect: write
      questions:
      - How do I make a custom admin role with limited permissions?
      - Can I build a read-only role for auditors?
      instructions:
      - text: Create an admin role named {name} with scopes {scopes}.
        slots:
          name: requestBody.name
          scopes: requestBody.scopes
      - text: Add role {name} described as {description} granting {scopes}.
        slots:
          name: requestBody.name
          description: requestBody.description
          scopes: requestBody.scopes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/roles/scopes'].get
  update:
    x-apievangelist-phrasing:
      intent: List scopes available to admin roles
      effect: read
      questions:
      - What permission scopes can be granted to an admin role?
      - Which scopes exist for building admin roles?
      instructions:
      - text: List every scope an admin role can include.
      - text: Show the permission scopes available for roles.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/roles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an admin role
      effect: read
      questions:
      - How do I see which scopes a particular admin role grants?
      - What does one admin role contain?
      instructions:
      - text: Show admin role {id}.
        slots:
          id: path.id
      - text: Get the scopes granted by role {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/roles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an admin role
      effect: write
      questions:
      - How do I add a scope to an existing admin role?
      - Can the default admin role be modified?
      instructions:
      - text: Update admin role {id} to grant scopes {scopes}.
        slots:
          id: path.id
          scopes: requestBody.scopes
      - text: Rename admin role {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/roles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an admin role
      effect: destructive
      questions:
      - How do I remove a custom admin role?
      - Can I delete an admin role nobody uses anymore?
      instructions:
      - text: Delete admin role {id}.
        slots:
          id: path.id
      - text: Remove the unused role {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'