# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Nylas Workspaces API
  version: 1.0.0
extends: openapi/nylas-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: 7
- target: $.paths['/v3/workspaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List all workspaces
      effect: read
      questions:
      - What workspaces exist in my Nylas application?
      - Can I see every workspace my API key's app has?
      instructions:
      - text: List all workspaces in my application.
      - text: Show every workspace in this app.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/workspaces'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a workspace for a domain
      effect: write
      questions:
      - How do I create a workspace for my company's email domain?
      - Can I attach a policy and rules to a new workspace?
      - Is the workspace domain changeable after creation?
      instructions:
      - text: Create a workspace named {name} for domain {domain}.
        slots:
          name: requestBody.name
          domain: requestBody.domain
      - text: Create workspace {name} on {domain} with policy {policy_id} attached.
        slots:
          name: requestBody.name
          domain: requestBody.domain
          policy_id: requestBody.policy_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/workspaces/{workspace_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one workspace
      effect: read
      questions:
      - What policy and rules are attached to a particular workspace?
      - Can I look up a workspace by its ID?
      instructions:
      - text: Show workspace {workspace}.
        slots:
          workspace: path.workspace_id
      - text: Get the settings of workspace {workspace}.
        slots:
          workspace: path.workspace_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/workspaces/{workspace_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a workspace
      effect: destructive
      questions:
      - What happens to a workspace's grants when I delete it?
      - Can I delete the default workspace?
      instructions:
      - text: Delete workspace {workspace}.
        slots:
          workspace: path.workspace_id
      - text: Remove workspace {workspace} and move its grants out.
        slots:
          workspace: path.workspace_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/workspaces/{workspace_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a workspace's name, policy or rules
      effect: write
      questions:
      - Can I switch the policy attached to an existing workspace?
      - What can I change on the default workspace?
      instructions:
      - text: Rename workspace {workspace} to {name}.
        slots:
          workspace: path.workspace_id
          name: requestBody.name
      - text: Attach policy {policy_id} to workspace {workspace}.
        slots:
          policy_id: requestBody.policy_id
          workspace: path.workspace_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/workspaces/auto-group'].post
  update:
    x-apievangelist-phrasing:
      intent: Auto-group grants into workspaces
      effect: write
      questions:
      - How do I automatically sort grants into workspaces by email domain?
      - Can auto-grouping include invalid grants too?
      instructions:
      - text: Auto-group grants from domain {specific_domain} into their workspace.
        slots:
          specific_domain: requestBody.specific_domain
      - text: Auto-group every grant created after {after_created_at}.
        slots:
          after_created_at: requestBody.after_created_at
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/workspaces/{workspace_id}/manual-assign'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign or remove grants in a workspace
      effect: write
      questions:
      - Can I manually move specific grants into a workspace?
      - How many grants can I assign to a workspace in one request?
      instructions:
      - text: Assign grants {assign_grants} to workspace {workspace}.
        slots:
          assign_grants: requestBody.assign_grants
          workspace: path.workspace_id
      - text: Remove grants {remove_grants} from workspace {workspace}.
        slots:
          remove_grants: requestBody.remove_grants
          workspace: path.workspace_id
      method: generated
      generated: '2026-09-26'