# 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 Role API
  version: 1.0.0
extends: openapi/strivacity-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: 5
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List roles in an identity store
      effect: read
      questions:
      - Which roles are defined in my identity store?
      - Can I search roles by name?
      instructions:
      - text: List roles in identity store {store}.
        slots:
          store: path.identityStoreName
      - text: Find roles named {name} in {store}.
        slots:
          name: query.name
          store: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/roles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a role
      effect: write
      questions:
      - How do I define a new role with specific scopes?
      - Can a role be made the default for new accounts?
      instructions:
      - text: Create role {name} with scopes {scopes} in identity store {store}.
        slots:
          name: requestBody.name
          scopes: requestBody.scopes
          store: path.identityStoreName
      - text: Add a new role {name} to {store}.
        slots:
          name: requestBody.name
          store: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/roles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a role
      effect: read
      questions:
      - What scopes does a given role grant?
      - Can I view one role's definition?
      instructions:
      - text: Get role {id} in identity store {store}.
        slots:
          id: path.id
          store: path.identityStoreName
      - text: Show the scopes of role {id} in {store}.
        slots:
          id: path.id
          store: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/roles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a role
      effect: write
      questions:
      - How do I change the scopes a role grants?
      - Can I rename an existing role?
      instructions:
      - text: Update role {id} in {store} to scopes {scopes}.
        slots:
          id: path.id
          store: path.identityStoreName
          scopes: requestBody.scopes
      - text: Rename role {id} in identity store {store} to {name}.
        slots:
          id: path.id
          store: path.identityStoreName
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/roles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a role
      effect: destructive
      questions:
      - How do I remove a role I no longer use?
      - Why can't I delete a role that is assigned to accounts?
      instructions:
      - text: Delete role {id} from identity store {store}.
        slots:
          id: path.id
          store: path.identityStoreName
      - text: Remove the unused role {id} in {store}.
        slots:
          id: path.id
          store: path.identityStoreName
      method: generated
      generated: '2026-10-01'