# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Sigma Computing Workspaces API
  version: 1.0.0
extends: openapi/sigma-computing-workspaces-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: 9
- target: $.paths['/v2/workspaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List workspaces (v2)
      effect: read
      questions:
      - What workspaces exist in my organization, using the original v2 list?
      - Can the v2 workspace list filter by an exact name?
      instructions:
      - text: List all workspaces with the v2 endpoint.
      - text: Using the v2 workspace list, find workspaces named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/workspaces'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a workspace
      effect: write
      questions:
      - How do I create a new workspace for a project?
      - Can I prevent creating a workspace whose name already exists?
      instructions:
      - text: Create a workspace named {name}.
        slots:
          name: requestBody.name
      - text: 'Create workspace {name} unless one with that name exists: {noDuplicates}.'
        slots:
          name: requestBody.name
          noDuplicates: requestBody.noDuplicates
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/workspaces/{workspaceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workspace
      effect: read
      questions:
      - How do I view the details of a single workspace?
      - What information comes back for a workspace ID?
      instructions:
      - text: Get workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      - text: Show the details of workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/workspaces/{workspaceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a workspace permanently
      effect: destructive
      questions:
      - Can a deleted workspace be recovered?
      - How do I remove a workspace that is no longer used?
      instructions:
      - text: Delete workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      - text: Permanently remove the unused workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/workspaces/{workspaceId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a workspace
      effect: write
      questions:
      - How do I rename a workspace?
      - Will renaming a workspace fail if the new name is taken?
      instructions:
      - text: Rename workspace {workspaceId} to {name}.
        slots:
          workspaceId: path.workspaceId
          name: requestBody.name
      - text: 'Rename workspace {workspaceId} to {name}, blocking duplicates: {noDuplicates}.'
        slots:
          workspaceId: path.workspaceId
          name: requestBody.name
          noDuplicates: requestBody.noDuplicates
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/workspaces/{workspaceId}/grants'].get
  update:
    x-apievangelist-phrasing:
      intent: List permissions on a workspace
      effect: read
      questions:
      - Who has access to a workspace and at what level?
      - Which teams are granted permissions on a workspace?
      instructions:
      - text: List grants on workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      - text: Show users and teams with access to workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/workspaces/{workspaceId}/grants'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant workspace access to users or teams
      effect: write
      questions:
      - How do I give a team access to a workspace?
      - Can I set a different permission level for each grantee on a workspace?
      instructions:
      - text: Grant {grants} on workspace {workspaceId}.
        slots:
          grants: requestBody.grants
          workspaceId: path.workspaceId
      - text: Give the users and teams in {grants} access to workspace {workspaceId}.
        slots:
          grants: requestBody.grants
          workspaceId: path.workspaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/workspaces/{workspaceId}/grants/{grantId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a workspace permission
      effect: destructive
      questions:
      - How do I remove a team's access to a workspace?
      - Can I delete one specific grant on a workspace?
      instructions:
      - text: Delete grant {grantId} on workspace {workspaceId}.
        slots:
          grantId: path.grantId
          workspaceId: path.workspaceId
      - text: Revoke workspace {workspaceId} access from grant {grantId}.
        slots:
          workspaceId: path.workspaceId
          grantId: path.grantId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2.1/workspaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List workspaces (paginated v2.1)
      effect: read
      questions:
      - Which workspace list endpoint paginates by default?
      - How do I page through a large number of workspaces on v2.1?
      instructions:
      - text: Page through workspaces with v2.1, {limit} per page.
        slots:
          limit: query.limit
      - text: Using the paginated v2.1 list, find the workspace exactly named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'