# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ThousandEyes Roles API
  version: 1.0.0
extends: openapi/thousandeyes-roles-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: 5
- target: $.paths['/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List roles
      effect: read
      questions:
      - Which user roles are defined in my account?
      - Can I see the roles visible to me in an account group?
      instructions:
      - text: List all roles.
      - text: Show roles in account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/roles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom role
      effect: write
      questions:
      - Can I define a custom role with only certain permissions?
      - What do I send to create a new role?
      instructions:
      - text: Create a role named {name} with permissions {permissions}.
        slots:
          name: requestBody.name
          permissions: requestBody.permissions
      - text: Add a new custom role called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/roles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a role's permissions
      effect: read
      questions:
      - What permissions does a specific role grant?
      - Can I look up one role by its ID?
      instructions:
      - text: Show role {id}.
        slots:
          id: path.id
      - text: List the permissions granted by role {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/roles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a user-defined role
      effect: write
      questions:
      - Do I need to send the full permission list when editing a role?
      - Can I rename a custom role?
      instructions:
      - text: Set the permissions of role {id} to {permissions}.
        slots:
          id: path.id
          permissions: requestBody.permissions
      - text: Rename role {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/roles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a role
      effect: destructive
      questions:
      - Can I delete a custom role we no longer use?
      - What permissions are needed to remove a role?
      instructions:
      - text: Delete role {id}.
        slots:
          id: path.id
      - text: Remove role {id} from account group {aid}.
        slots:
          id: path.id
          aid: query.aid
      method: generated
      generated: '2026-09-26'