API Evangelist conversational phrasing for Postman Workspaces API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Postman Workspaces API
  version: 1.0.0
extends: openapi/postman-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: 19
- target: $.paths['/invitations'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite or remove Partner Workspace partners
      effect: write
      questions:
      - How do I invite external partners by email to a Partner Workspace?
      - Can I remove a partner from all of a partnership's workspaces at once?
      - Which plans support managing Partner Workspace invitations?
      instructions:
      - text: Send Partner Workspace invitations to these partner emails.
      - text: Remove this partner from the partnership and all its workspaces.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List workspaces
      effect: read
      questions:
      - Which workspaces do I have access to?
      - Can I filter workspaces by type or by who created them?
      - How do I find which workspace a given collection lives in?
      instructions:
      - text: List all my workspaces.
      - text: List {type} workspaces created by user {createdBy}.
        slots:
          type: query.type
          createdBy: query.createdBy
      - text: Find the workspace containing {elementType} {elementId}.
        slots:
          elementType: query.elementType
          elementId: query.elementId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a workspace
      effect: write
      questions:
      - How do I create a new team workspace?
      - Why would creating a workspace return a Forbidden error?
      instructions:
      - text: Create a workspace {workspace}.
        slots:
          workspace: requestBody.workspace
      - text: Set up a new personal workspace for my project.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces-roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List the available workspace roles
      effect: read
      questions:
      - What roles can be assigned in a workspace on my plan?
      - Which workspace role IDs exist so I can assign them?
      instructions:
      - text: List every workspace role my team's plan offers.
      - text: Show the available workspace role definitions.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workspace
      effect: read
      questions:
      - How do I look up one workspace's details and visibility?
      - Can I see what collections and environments are inside a workspace?
      instructions:
      - text: Get workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      - text: Show the details and visibility of workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a workspace or change its visibility
      effect: write
      questions:
      - Can I rename a workspace or make it public?
      - Which workspace visibility changes are not allowed on Free and Solo plans?
      instructions:
      - text: Update workspace {workspaceId} with {workspace}.
        slots:
          workspaceId: path.workspaceId
          workspace: requestBody.workspace
      - text: Rename workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a workspace
      effect: destructive
      questions:
      - How do I delete a workspace I no longer use?
      - Can I remove a whole workspace through the API?
      instructions:
      - text: Delete workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      - text: Permanently remove the workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/activities'].get
  update:
    x-apievangelist-phrasing:
      intent: View a workspace's activity feed
      effect: read
      questions:
      - What has changed recently in this workspace and who did it?
      - Can I filter a workspace's activity to one user or element type?
      instructions:
      - text: Show the activity feed for workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      - text: Show what user {userId} did in workspace {workspaceId}.
        slots:
          userId: query.userId
          workspaceId: path.workspaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/element-transfers'].post
  update:
    x-apievangelist-phrasing:
      intent: Move an element to another workspace
      effect: write
      questions:
      - How do I move a collection or environment from one workspace to another?
      - Which kinds of elements can be transferred between workspaces?
      instructions:
      - text: Move {type} {id} from workspace {workspaceId} to {to}.
        slots:
          type: requestBody.type
          id: requestBody.id
          workspaceId: path.workspaceId
          to: requestBody.to
      - text: Transfer element {id} of type {type} out of workspace {workspaceId} into {to}.
        slots:
          id: requestBody.id
          type: requestBody.type
          workspaceId: path.workspaceId
          to: requestBody.to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/global-variables'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workspace's global variables
      effect: read
      questions:
      - What global variables are defined in this workspace?
      - Can I read the globals shared across a workspace's collections and scripts?
      instructions:
      - text: Get the global variables of workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      - text: Show the globals defined in workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/global-variables'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a workspace's global variables
      effect: write
      questions:
      - Does updating global variables replace all existing ones in the workspace?
      - How do I set new global variable values for a workspace?
      instructions:
      - text: Replace the global variables of workspace {workspaceId} with {values}.
        slots:
          workspaceId: path.workspaceId
          values: requestBody.values
      - text: Overwrite workspace {workspaceId} globals so they match {values}.
        slots:
          workspaceId: path.workspaceId
          values: requestBody.values
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: See who has which role in a workspace
      effect: read
      questions:
      - Who are the members of this workspace and what roles do they have?
      - Can I see user group and partner roles on a workspace?
      instructions:
      - text: List the roles in workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      - text: Show which users, groups and partners have access to workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/roles'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change members' roles in a workspace
      effect: write
      questions:
      - How do I make someone an admin of a workspace?
      - Can I update workspace roles using SCIM IDs instead of Postman user IDs?
      instructions:
      - text: Update the roles in workspace {workspaceId} with {roles}.
        slots:
          workspaceId: path.workspaceId
          roles: requestBody.roles
      - text: Assign workspace {workspaceId} roles {roles} using {identifierType} IDs.
        slots:
          workspaceId: path.workspaceId
          roles: requestBody.roles
          identifierType: header.identifierType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/transfers'].patch
  update:
    x-apievangelist-phrasing:
      intent: Move a workspace to another team
      effect: write
      questions:
      - Can I transfer a workspace from one team to another in my organization?
      - Which plan is required to move workspaces between teams?
      instructions:
      - text: Transfer workspace {workspaceId} from team {source} to team {destination}.
        slots:
          workspaceId: path.workspaceId
          source: requestBody.source
          destination: requestBody.destination
      - text: Move workspace {workspaceId} over to team {destination} from {source}.
        slots:
          workspaceId: path.workspaceId
          destination: requestBody.destination
          source: requestBody.source
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/updates'].get
  update:
    x-apievangelist-phrasing:
      intent: List a workspace's updates
      effect: read
      questions:
      - What announcements have been posted as updates in this workspace?
      - Can I filter workspace updates by category?
      instructions:
      - text: List the updates posted in workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      - text: Show {category} updates in workspace {workspaceId}.
        slots:
          category: query.category
          workspaceId: path.workspaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/updates'].post
  update:
    x-apievangelist-phrasing:
      intent: Post an update to a workspace
      effect: write
      questions:
      - How do I post an announcement to keep workspace members informed?
      - Can a workspace update link to related collections or APIs?
      instructions:
      - text: 'Post a {category} update on {topic} to workspace {workspaceId}: {description}.'
        slots:
          category: requestBody.category
          topic: requestBody.topic
          workspaceId: path.workspaceId
          description: requestBody.description
      - text: Announce {description} in workspace {workspaceId} under topic {topic}, category {category}.
        slots:
          description: requestBody.description
          workspaceId: path.workspaceId
          topic: requestBody.topic
          category: requestBody.category
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/updates/{updateId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one workspace update
      effect: read
      questions:
      - How do I read a single workspace update by its ID?
      - Can I see the full text of one announcement in a workspace?
      instructions:
      - text: Get update {updateId} in workspace {workspaceId}.
        slots:
          updateId: path.updateId
          workspaceId: path.workspaceId
      - text: Show the workspace update {updateId} from {workspaceId}.
        slots:
          updateId: path.updateId
          workspaceId: path.workspaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/updates/{updateId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a workspace update
      effect: destructive
      questions:
      - How do I remove an announcement posted in a workspace?
      - Can I delete an outdated workspace update?
      instructions:
      - text: Delete update {updateId} from workspace {workspaceId}.
        slots:
          updateId: path.updateId
          workspaceId: path.workspaceId
      - text: Remove the workspace update {updateId} in {workspaceId}.
        slots:
          updateId: path.updateId
          workspaceId: path.workspaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/updates/{updateId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit or pin a workspace update
      effect: write
      questions:
      - Can I pin a workspace update so it stays at the top?
      - How do I edit the text of an update I already posted in a workspace?
      instructions:
      - text: 'Edit update {updateId} in workspace {workspaceId}: topic {topic}, category {category}, text {description}.'
        slots:
          updateId: path.updateId
          workspaceId: path.workspaceId
          topic: requestBody.topic
          category: requestBody.category
          description: requestBody.description
      - text: Pin update {updateId} in workspace {workspaceId} ({isPinned}) keeping topic {topic}, category {category}, text {description}.
        slots:
          updateId: path.updateId
          workspaceId: path.workspaceId
          isPinned: requestBody.isPinned
          topic: requestBody.topic
          category: requestBody.category
          description: requestBody.description
      method: generated
      generated: '2026-09-26'