# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DocuSign REST Workspaces API
  version: 1.0.0
extends: openapi/docusign-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: 5
- target: $.paths['/v2/accounts/{accountId}/workspaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List workspaces
      effect: read
      questions:
      - Which workspaces have been created in my account?
      - Can I get an overview of all collaboration workspaces?
      instructions:
      - text: List the workspaces in account {accountId}.
        slots:
          accountId: path.accountId
      - text: Show every workspace for account {accountId}.
        slots:
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/workspaces'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a workspace
      effect: write
      questions:
      - Can I create a new shared workspace with a name and description?
      - What can I set when I create a workspace?
      instructions:
      - text: Create a workspace named {workspaceName} in account {accountId}.
        slots:
          workspaceName: requestBody.workspaceName
          accountId: path.accountId
      - text: Set up a new workspace {workspaceName} described as {workspaceDescription}.
        slots:
          workspaceName: requestBody.workspaceName
          workspaceDescription: requestBody.workspaceDescription
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/workspaces/{workspaceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workspace
      effect: read
      questions:
      - What are the properties of a specific workspace?
      - Can I look up one workspace by its ID?
      instructions:
      - text: Get workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      - text: Show the details of workspace {workspaceId} in account {accountId}.
        slots:
          workspaceId: path.workspaceId
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/workspaces/{workspaceId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a workspace
      effect: write
      questions:
      - Can I rename a workspace or change its description?
      - Is it possible to change a workspace's status?
      instructions:
      - text: Rename workspace {workspaceId} to {workspaceName}.
        slots:
          workspaceId: path.workspaceId
          workspaceName: requestBody.workspaceName
      - text: Update the description of workspace {workspaceId} in account {accountId} to {workspaceDescription}.
        slots:
          workspaceId: path.workspaceId
          accountId: path.accountId
          workspaceDescription: requestBody.workspaceDescription
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/workspaces/{workspaceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a workspace
      effect: destructive
      questions:
      - Is deleting a workspace a logical delete rather than a permanent purge?
      - Can I remove a workspace that's no longer needed?
      instructions:
      - text: Delete workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      - text: Remove workspace {workspaceId} from account {accountId}.
        slots:
          workspaceId: path.workspaceId
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'