Asana · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Asana Workspaces API

8 actions 8 updates phrasing extends openapi/asana-workspaces-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Asana's API. It is a proposal applied on top of the contract, not a document Asana publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info

$.paths['/workspaces/{workspace_gid}/tags'].get

$.paths['/workspaces/{workspace_gid}/tags'].post

$.paths['/workspaces'].get

$.paths['/workspaces/{workspace_gid}'].get

$.paths['/workspaces/{workspace_gid}'].put

$.paths['/workspaces/{workspace_gid}/addUser'].post

$.paths['/workspaces/{workspace_gid}/removeUser'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Asana Workspaces API
  version: 1.0.0
extends: openapi/asana-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: 7
- target: $.paths['/workspaces/{workspace_gid}/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List the tags in a workspace
      effect: read
      questions:
      - What tags already exist in a given workspace?
      - Can I page through a workspace's tags?
      instructions:
      - text: List the tags in workspace {workspace}.
        slots:
          workspace: path.workspace_gid
      - text: Show all tags defined in workspace {workspace}.
        slots:
          workspace: path.workspace_gid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace_gid}/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a tag in a specific workspace
      effect: write
      questions:
      - How do I create a tag scoped to a particular workspace by its ID?
      - Can a tag be moved to another workspace once created?
      instructions:
      - text: Create tag {tag} in workspace {workspace}.
        slots:
          workspace: path.workspace_gid
          tag: requestBody.data
      - text: Add a new label {tag} to workspace {workspace}.
        slots:
          workspace: path.workspace_gid
          tag: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List my workspaces
      effect: read
      questions:
      - Which workspaces and organizations can I access?
      - How do I find my workspace ID?
      instructions:
      - text: List my workspaces.
      - text: Show every workspace and organization I can see.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace_gid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workspace's details
      effect: read
      questions:
      - Is a given workspace an organization?
      - What email domains are tied to a workspace?
      instructions:
      - text: Show workspace {workspace}.
        slots:
          workspace: path.workspace_gid
      - text: Fetch the details of workspace {workspace}.
        slots:
          workspace: path.workspace_gid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace_gid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a workspace
      effect: write
      questions:
      - Can I change a workspace's name?
      - Which workspace settings are editable?
      instructions:
      - text: Rename workspace {workspace} to {name}.
        slots:
          workspace: path.workspace_gid
          name: requestBody.data
      - text: Update workspace {workspace} with {changes}.
        slots:
          workspace: path.workspace_gid
          changes: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace_gid}/addUser'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a user to a workspace
      effect: write
      questions:
      - How do I invite someone to my workspace by email?
      - Can I add a user to an organization using their user ID?
      instructions:
      - text: Add {user} to workspace {workspace}.
        slots:
          workspace: path.workspace_gid
          user: requestBody.data
      - text: Invite {email} to organization {workspace}.
        slots:
          workspace: path.workspace_gid
          email: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace_gid}/removeUser'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from a workspace
      effect: destructive
      questions:
      - Do I need to be an admin to remove someone from a workspace?
      - Can I remove a user from an organization by email address?
      instructions:
      - text: Remove {user} from workspace {workspace}.
        slots:
          workspace: path.workspace_gid
          user: requestBody.data
      - text: Take {email} out of organization {workspace}.
        slots:
          workspace: path.workspace_gid
          email: requestBody.data
      method: generated
      generated: '2026-10-01'