# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Identity Exposure Role API
  version: 1.0.0
extends: openapi/tenable-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: 8
- target: $.paths['/api/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List roles
      effect: read
      questions:
      - Which roles exist in Identity Exposure?
      - Can I list all roles?
      instructions:
      - text: List all roles.
      - text: Show every role defined.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/roles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a role
      effect: write
      questions:
      - How do I create a new empty role?
      - Can I add a custom role?
      instructions:
      - text: Create a new role.
      - text: Add a blank custom role.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/roles/user-creation-defaults'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default roles for new users
      effect: read
      questions:
      - Which roles do new users get by default?
      - What are the role defaults applied when a user is created?
      instructions:
      - text: Show the default roles for user creation.
      - text: Get roles assigned automatically to new users.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/roles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a role
      effect: read
      questions:
      - How do I view one role's description?
      - What does a given role contain?
      instructions:
      - text: Get role {id}.
        slots:
          id: path.id
      - text: Show the details of role {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/roles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a role
      effect: destructive
      questions:
      - How do I remove a role?
      - Can I delete a custom role I created?
      instructions:
      - text: Delete role {id}.
        slots:
          id: path.id
      - text: Remove custom role {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/roles/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or redescribe a role
      effect: write
      questions:
      - Can I rename a role?
      - How do I update a role's description?
      instructions:
      - text: Rename role {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set the description of role {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/roles/from/{fromId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy a role into a new one
      effect: write
      questions:
      - Can I clone an existing role?
      - How do I duplicate a role under a new name?
      instructions:
      - text: Create role {name} from role {fromId}.
        slots:
          name: requestBody.name
          fromId: path.fromId
      - text: Clone role {fromId} as {name}.
        slots:
          fromId: path.fromId
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/roles/{id}/permissions'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a role's permissions
      effect: write
      questions:
      - How do I set exactly which permissions a role grants?
      - Does updating permissions overwrite the existing list?
      instructions:
      - text: Replace the permission list on role {id}.
        slots:
          id: path.id
      - text: Overwrite permissions for role {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'