# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Tenable Platform & Settings Access Control (Roles) API
  version: 1.0.0
extends: openapi/tenable-access-control-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: 6
- target: $.paths['/access-control/v1/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List standard and custom roles
      effect: read
      questions:
      - What roles, standard and custom, are defined in my instance?
      - Which custom roles have we created so far?
      instructions:
      - text: List all roles in the workspace.
      - text: Show me both the standard and custom roles.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/access-control/v1/roles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom role
      effect: write
      questions:
      - How do I create a custom role with a specific set of privileges?
      - Can I give a new custom role a description?
      instructions:
      - text: Create a custom role {name} with permissions {role_permission_strings}.
        slots:
          name: requestBody.name
          role_permission_strings: requestBody.role_permission_strings
      - text: Create role {name} ({description}) granting {role_permission_strings}.
        slots:
          name: requestBody.name
          description: requestBody.description
          role_permission_strings: requestBody.role_permission_strings
      method: generated
      generated: '2026-10-01'
- target: $.paths['/access-control/v1/roles/{role_uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a role's details
      effect: read
      questions:
      - Which privileges does a particular role grant?
      - Can I inspect one role by its UUID?
      instructions:
      - text: Show the details of role {role_uuid}.
        slots:
          role_uuid: path.role_uuid
      - text: List the privileges included in role {role_uuid}.
        slots:
          role_uuid: path.role_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/access-control/v1/roles/{role_uuid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom role
      effect: write
      questions:
      - How do I add or remove privileges on an existing custom role?
      - Can I rename a custom role after creating it?
      instructions:
      - text: Set the permissions of role {role_uuid} to {role_permission_strings}.
        slots:
          role_uuid: path.role_uuid
          role_permission_strings: requestBody.role_permission_strings
      - text: Rename custom role {role_uuid} to {name}.
        slots:
          role_uuid: path.role_uuid
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/access-control/v1/roles/{role_uuid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom role
      effect: destructive
      questions:
      - How do I delete a custom role we no longer need?
      - Can standard roles be deleted or only custom ones?
      instructions:
      - text: Delete custom role {role_uuid}.
        slots:
          role_uuid: path.role_uuid
      - text: Remove the role {role_uuid}.
        slots:
          role_uuid: path.role_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/access-control/v1/role-permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List available role permission strings
      effect: read
      questions:
      - What privilege strings can I use when building a custom role?
      - How are the role permissions organized hierarchically?
      instructions:
      - text: List every available role permission string.
      - text: Show the custom role privileges and how they nest.
      method: generated
      generated: '2026-10-01'