# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Console Roles API
  version: 1.0.0
extends: openapi/statsig-roles-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['/console/v1/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List roles
      effect: read
      questions:
      - What custom roles are defined for our organization?
      - Can I page through every role?
      instructions:
      - text: List all roles.
      - text: Show roles page {page}, {limit} per page.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/roles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom role
      effect: write
      questions:
      - How do I define a custom role with specific permissions?
      - Can I create a role that only lets people edit experiments?
      instructions:
      - text: Create role {name} with permissions {permissions}.
        slots:
          name: requestBody.name
          permissions: requestBody.permissions
      - text: Add a custom role called {name} granting {permissions}.
        slots:
          name: requestBody.name
          permissions: requestBody.permissions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/roles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a role's permissions
      effect: read
      questions:
      - What permissions does a particular role grant?
      - Can I inspect one role by ID?
      instructions:
      - text: Show role {id}.
        slots:
          id: path.id
      - text: List the permissions of role {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/roles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a role
      effect: destructive
      questions:
      - Can I delete a custom role nobody uses?
      - Is removing a role permanent?
      instructions:
      - text: Delete role {id}.
        slots:
          id: path.id
      - text: Remove the custom role {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/roles/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a role's permissions
      effect: write
      questions:
      - How do I add a permission to an existing role?
      - Can I tighten what a custom role is allowed to do?
      instructions:
      - text: Set role {id}'s permissions to {permissions}.
        slots:
          id: path.id
          permissions: requestBody.permissions
      - text: Update the permissions on role {id} to {permissions}.
        slots:
          id: path.id
          permissions: requestBody.permissions
      method: generated
      generated: '2026-10-01'