ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Users API

7 actions 7 updates phrasing extends openapi/thousandeyes-users-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for ThousandEyes's API. It is a proposal applied on top of the contract, not a document ThousandEyes publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info

$.paths['/users'].get

$.paths['/users'].post

$.paths['/users/{id}'].get

$.paths['/users/{id}'].put

$.paths['/users/{id}'].delete

$.paths['/users/current'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ThousandEyes Users API
  version: 1.0.0
extends: openapi/thousandeyes-users-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: 6
- target: $.paths['/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users
      effect: read
      questions:
      - Who are all the users in my ThousandEyes organization?
      - What permissions do I need to list every user?
      instructions:
      - text: List all users in my organization.
      - text: Show the users visible from account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite a new user
      effect: write
      questions:
      - How do I add a new user and give them roles in specific account groups?
      - Can I set a new user's login account group when I create them?
      instructions:
      - text: Create a user named {name} with email {email}.
        slots:
          name: requestBody.name
          email: requestBody.email
      - text: Add user {email} with login account group {loginAccountGroupId}.
        slots:
          email: requestBody.email
          loginAccountGroupId: requestBody.loginAccountGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user
      effect: read
      questions:
      - Where can I see a particular user's roles and account groups?
      - Can I look up one user by ID?
      instructions:
      - text: Show user {id}.
        slots:
          id: path.id
      - text: Get the details and roles of user {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a user
      effect: write
      questions:
      - How do I change a user's email address or roles?
      - Can I move a user to a different login account group?
      instructions:
      - text: Change the email of user {id} to {email}.
        slots:
          id: path.id
          email: requestBody.email
      - text: Rename user {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update the account group roles of user {id} to {accountGroupRoles}.
        slots:
          id: path.id
          accountGroupRoles: requestBody.accountGroupRoles
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user
      effect: destructive
      questions:
      - Someone left the team; can I remove their user account?
      - What permission do I need to delete a user?
      instructions:
      - text: Delete user {id}.
        slots:
          id: path.id
      - text: Remove user {id} from the organization.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/current'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current user
      effect: read
      questions:
      - Who am I logged in as through the API?
      - How do I check my own user profile and roles?
      instructions:
      - text: Show my own user details.
      - text: Get the currently authenticated user.
      method: generated
      generated: '2026-09-26'