Asana · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Asana Allocations API

6 actions 6 updates phrasing extends openapi/asana-allocations-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['/allocations/{allocation_gid}'].get

$.paths['/allocations/{allocation_gid}'].put

$.paths['/allocations/{allocation_gid}'].delete

$.paths['/allocations'].get

$.paths['/allocations'].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 Allocations API
  version: 1.0.0
extends: openapi/asana-allocations-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['/allocations/{allocation_gid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a resource allocation
      effect: read
      questions:
      - What does a single allocation record show about someone's planned effort?
      - Can I look up an allocation's dates and effort by ID?
      instructions:
      - text: Show allocation {allocation}.
        slots:
          allocation: path.allocation_gid
      - text: Fetch the details of allocation {allocation}.
        slots:
          allocation: path.allocation_gid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/allocations/{allocation_gid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a resource allocation
      effect: write
      questions:
      - Can I change the dates or effort on an existing allocation?
      - Do fields I don't send in an allocation update stay the same?
      instructions:
      - text: Change allocation {allocation} to {changes}.
        slots:
          allocation: path.allocation_gid
          changes: requestBody.data
      - text: Extend allocation {allocation} to end on {end_date}.
        slots:
          allocation: path.allocation_gid
          end_date: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/allocations/{allocation_gid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a resource allocation
      effect: destructive
      questions:
      - Can I cancel someone's allocation to a project?
      - What does deleting an allocation return?
      instructions:
      - text: Delete allocation {allocation}.
        slots:
          allocation: path.allocation_gid
      - text: Remove the allocation {allocation}.
        slots:
          allocation: path.allocation_gid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/allocations'].get
  update:
    x-apievangelist-phrasing:
      intent: List allocations for a project or person
      effect: read
      questions:
      - How much of a person's time is allocated across projects?
      - Which people are allocated to a given project?
      instructions:
      - text: List allocations for project {project}.
        slots:
          project: query.parent
      - text: Show allocations assigned to {assignee} in workspace {workspace}.
        slots:
          assignee: query.assignee
          workspace: query.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/allocations'].post
  update:
    x-apievangelist-phrasing:
      intent: Allocate a person to a project
      effect: write
      questions:
      - How do I plan a teammate's capacity on a project?
      - Can I set start and end dates and effort when allocating someone?
      instructions:
      - text: Allocate {assignee} to a project with {details}.
        slots:
          assignee: requestBody.data
          details: requestBody.data
      - text: Create an allocation with {details}.
        slots:
          details: requestBody.data
      method: generated
      generated: '2026-10-01'