# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Workfront Workspaces API
  version: 1.0.0
extends: openapi/workfront-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: 8
- target: $.paths['/v1/workspaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List all workspaces (legacy v1)
      effect: read
      questions:
      - Can the older v1 API list every workspace without cursor paging?
      - Which v1 call returns all my workspaces with chosen attributes?
      instructions:
      - text: List all workspaces using the legacy v1 endpoint.
      - text: Get every workspace from the v1 API with attributes {attributes}.
        slots:
          attributes: query.attributes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/workspaces/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch a workspace with the legacy v1 endpoint
      effect: read
      questions:
      - Is there a v1 endpoint that still returns one workspace by ID?
      - Can I pick which attributes come back for a workspace on the v1 API?
      instructions:
      - text: Fetch workspace {id} via the legacy v1 endpoint.
        slots:
          id: path.id
      - text: Get v1 workspace {id} including only attributes {attributes}.
        slots:
          id: path.id
          attributes: query.attributes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/workspaces/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workspace by ID
      effect: read
      questions:
      - How do I look up a workspace's name, owner and record type sections?
      - What details does Workfront Planning return for one workspace?
      instructions:
      - text: Get workspace {id}.
        slots:
          id: path.id
      - text: Show me who owns workspace {id} and how its sections are organized.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/workspaces/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a workspace's settings in full
      effect: write
      questions:
      - What happens to workspace settings I leave out on a full replacement?
      - Can I overwrite a workspace's name, description and owner in one request?
      instructions:
      - text: Fully replace workspace {id} with name {name}, clearing anything not sent.
        slots:
          id: path.id
          name: requestBody.name
      - text: Overwrite workspace {id} with name {name}, owner {ownerId} and sections {recordTypeSections}.
        slots:
          id: path.id
          name: requestBody.name
          ownerId: requestBody.ownerId
          recordTypeSections: requestBody.recordTypeSections
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/workspaces/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a workspace
      effect: destructive
      questions:
      - How do I delete a workspace I no longer need?
      - Can I remove a Planning workspace by its ID?
      instructions:
      - text: Delete workspace {id}.
        slots:
          id: path.id
      - text: Permanently remove the workspace with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/workspaces/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change some settings on a workspace
      effect: write
      questions:
      - Can I rename a workspace without touching its other settings?
      - Is there a way to hand a workspace to a new owner and leave everything else as is?
      instructions:
      - text: Rename workspace {id} to {name}, leaving everything else unchanged.
        slots:
          id: path.id
          name: requestBody.name
      - text: Patch workspace {id} so its owner becomes user {ownerId}.
        slots:
          id: path.id
          ownerId: requestBody.ownerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/workspaces'].get
  update:
    x-apievangelist-phrasing:
      intent: Page through all workspaces
      effect: read
      questions:
      - What workspaces do I have in Workfront Planning?
      - How many workspaces can one page of results include?
      instructions:
      - text: List my workspaces.
      - text: Show the next {limit} workspaces after cursor {cursor}.
        slots:
          limit: query.limit
          cursor: query.cursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/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 description, icon and color when I create it?
      instructions:
      - text: Create a workspace named {name}.
        slots:
          name: requestBody.name
      - text: Set up a new workspace {name} described as {description} with color {color}.
        slots:
          name: requestBody.name
          description: requestBody.description
          color: requestBody.color
      method: generated
      generated: '2026-10-01'