Asana · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Asana Users API

6 actions 6 updates phrasing extends openapi/asana-users-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 6

$.info

$.paths['/users'].get

$.paths['/users/{user_gid}'].get

$.paths['/users/{user_gid}/favorites'].get

$.paths['/teams/{team_gid}/users'].get

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

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 Users API
  version: 1.0.0
extends: openapi/asana-users-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['/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users I can see
      effect: read
      questions:
      - Which users can I see across my workspaces?
      - Can I narrow the user list to one workspace or team?
      instructions:
      - text: List users in workspace {workspace}.
        slots:
          workspace: query.workspace
      - text: Show the users on team {team} from the general user list.
        slots:
          team: query.team
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user_gid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's profile
      effect: read
      questions:
      - How do I look up a user's name and email?
      - Can I look up a user by email address or by the word me?
      instructions:
      - text: Show user {user}.
        slots:
          user: path.user_gid
      - text: Fetch the profile for {user}.
        slots:
          user: path.user_gid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user_gid}/favorites'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's favorites
      effect: read
      questions:
      - What projects has a user starred as favorites?
      - Are favorites returned in the same order as the sidebar?
      instructions:
      - text: List {user}'s favorite {type} in workspace {workspace}.
        slots:
          user: path.user_gid
          type: query.resource_type
          workspace: query.workspace
      - text: Show my favorite projects in workspace {workspace} for user {user} of type {type}.
        slots:
          user: path.user_gid
          type: query.resource_type
          workspace: query.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/teams/{team_gid}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List the users in a team
      effect: read
      questions:
      - Who is on a particular team?
      - Is the team member list capped, and how is it sorted?
      instructions:
      - text: List the users on team {team}.
        slots:
          team: path.team_gid
      - text: Show everyone in team {team} alphabetically.
        slots:
          team: path.team_gid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace_gid}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List the users in a workspace
      effect: read
      questions:
      - Who are all the people in my organization?
      - How many users does the workspace user list return at most?
      instructions:
      - text: List the users in workspace {workspace}.
        slots:
          workspace: path.workspace_gid
      - text: Show everyone in organization {workspace}.
        slots:
          workspace: path.workspace_gid
      method: generated
      generated: '2026-10-01'