# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Identity Platform Roles Service API
  version: 1.0.0
extends: openapi/canonical-rolesservice-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: 9
- target: $.paths['/api/v0/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List roles
      effect: read
      questions:
      - Which roles exist in the identity platform admin?
      - What roles can I assign to groups?
      instructions:
      - text: List all roles.
      - text: Show every role defined in the identity platform.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/roles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a role
      effect: write
      questions:
      - How do I define a new role for access control?
      - Can I choose the id of a role when I create it?
      instructions:
      - text: Create role {name}.
        slots:
          name: requestBody.name
      - text: Create a role named {name} with id {id}.
        slots:
          name: requestBody.name
          id: requestBody.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/roles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a role
      effect: read
      questions:
      - What is the name of the role with a given id?
      - Can I look up one role's details?
      instructions:
      - text: Show role {id}.
        slots:
          id: path.id
      - text: Get the details of role {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/roles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a role
      effect: destructive
      questions:
      - How do I delete a role I no longer use?
      - Is removing a role permanent?
      instructions:
      - text: Delete role {id}.
        slots:
          id: path.id
      - text: Remove role {id} from the identity platform.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/roles/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a role
      effect: write
      questions:
      - Can I rename an existing role?
      - What fields of a role can be changed after it is created?
      instructions:
      - text: Rename role {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update the name of role {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/roles/{id}/entitlements'].get
  update:
    x-apievangelist-phrasing:
      intent: List a role's entitlements
      effect: read
      questions:
      - Which permissions does a particular role grant?
      - Can I page through a role's entitlements with a pagination token?
      instructions:
      - text: List the entitlements of role {id}.
        slots:
          id: path.id
      - text: Show role {id} entitlements from page token {token}.
        slots:
          id: path.id
          token: header.X-Token-Pagination
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/roles/{id}/entitlements'].patch
  update:
    x-apievangelist-phrasing:
      intent: Add or change a role's entitlements
      effect: write
      questions:
      - How do I grant extra permissions to a role?
      - Can I change several entitlements on a role in one request?
      instructions:
      - text: Apply entitlement updates {updates} to role {id}.
        slots:
          updates: requestBody.updates
          id: path.id
      - text: Grant role {id} the entitlements in {updates}.
        slots:
          id: path.id
          updates: requestBody.updates
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/roles/{id}/entitlements/{entitlementId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an entitlement from a role
      effect: destructive
      questions:
      - How do I revoke a single permission from a role?
      - Can I drop one entitlement and keep the rest of a role intact?
      instructions:
      - text: Remove entitlement {entitlementId} from role {id}.
        slots:
          entitlementId: path.entitlementId
          id: path.id
      - text: Revoke permission {entitlementId} on role {id}.
        slots:
          entitlementId: path.entitlementId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/roles/{id}/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List the groups assigned a role
      effect: read
      questions:
      - Which groups have been given a particular role?
      - Who inherits a role through group assignment?
      instructions:
      - text: List the groups that hold role {id}.
        slots:
          id: path.id
      - text: Show group assignments for role {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'