# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for NeoLoad Workspaces API
  version: 1.0.0
extends: openapi/tricentis-workspaces-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: 7
- target: $.paths['/v3/workspaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List accessible workspaces
      effect: read
      questions:
      - Which workspaces can I access?
      - Can I page through every workspace on the account, not just mine?
      instructions:
      - text: List the workspaces I can access.
      - text: List {limit} workspaces starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a workspace
      effect: write
      questions:
      - How do I set up a new workspace for a team?
      - Can I give a new workspace a virtual user quota?
      instructions:
      - text: Create a workspace named {name}.
        slots:
          name: requestBody.name
      - text: Create workspace {name} with a VU quota of {quota} open to all users.
        slots:
          name: requestBody.name
          quota: requestBody.vuQuota
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workspace
      effect: read
      questions:
      - How can I look up a single workspace's settings?
      - What VU quota does a given workspace have?
      instructions:
      - text: Get workspace {ws}.
        slots:
          ws: path.workspaceId
      - text: Show the details of workspace {ws}.
        slots:
          ws: path.workspaceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a workspace
      effect: write
      questions:
      - Can I rename a workspace or change its description?
      - How do I change a workspace's virtual user quota?
      instructions:
      - text: Rename workspace {ws} to {name}.
        slots:
          ws: path.workspaceId
          name: requestBody.name
      - text: Set the VU quota of workspace {ws} to {quota}.
        slots:
          ws: path.workspaceId
          quota: requestBody.vuQuota
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/members/add'].patch
  update:
    x-apievangelist-phrasing:
      intent: Add members to a workspace
      effect: write
      questions:
      - How can I give more people access to a workspace?
      - Can I add several users to a workspace by login at once?
      instructions:
      - text: Add {logins} as members of workspace {ws}.
        slots:
          ws: path.workspaceId
          logins: requestBody.logins
      - text: Give users {logins} access to workspace {ws}.
        slots:
          ws: path.workspaceId
          logins: requestBody.logins
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/members/remove'].patch
  update:
    x-apievangelist-phrasing:
      intent: Remove members from a workspace
      effect: write
      questions:
      - How do I take someone out of a workspace?
      - Can I remove several members from a workspace by login?
      instructions:
      - text: Remove {logins} from workspace {ws}.
        slots:
          ws: path.workspaceId
          logins: requestBody.logins
      - text: Revoke workspace {ws} membership for users {logins}.
        slots:
          ws: path.workspaceId
          logins: requestBody.logins
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/name/{workspaceName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a workspace
      effect: destructive
      questions:
      - What gets lost when I delete a workspace?
      - Why does deleting a workspace require its name as well as its ID?
      instructions:
      - text: Delete workspace {ws} named {name}.
        slots:
          ws: path.workspaceId
          name: path.workspaceName
      - text: Permanently remove workspace {ws} ({name}) and all its resources.
        slots:
          ws: path.workspaceId
          name: path.workspaceName
      method: generated
      generated: '2026-10-01'