Asana · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Asana Stories API

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

$.paths['/stories/{story_gid}'].put

$.paths['/stories/{story_gid}'].delete

$.paths['/tasks/{task_gid}/stories'].get

$.paths['/tasks/{task_gid}/stories'].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 Stories API
  version: 1.0.0
extends: openapi/asana-stories-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['/stories/{story_gid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a story or comment
      effect: read
      questions:
      - What does a single story or comment record contain?
      - Can I look up one comment on a task by its story ID?
      instructions:
      - text: Show story {story}.
        slots:
          story: path.story_gid
      - text: Fetch the comment {story}.
        slots:
          story: path.story_gid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stories/{story_gid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a comment
      effect: write
      questions:
      - Can I edit the text of a comment I posted?
      - Can I pin a comment so it stays at the top of a task?
      instructions:
      - text: Change the text of comment {story} to {text}.
        slots:
          story: path.story_gid
          text: requestBody.data
      - text: Pin comment {story} with {changes}.
        slots:
          story: path.story_gid
          changes: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stories/{story_gid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment
      effect: destructive
      questions:
      - Can I delete a comment someone else wrote?
      - How do I delete my own comment from a task?
      instructions:
      - text: Delete story {story}.
        slots:
          story: path.story_gid
      - text: Remove my comment {story}.
        slots:
          story: path.story_gid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tasks/{task_gid}/stories'].get
  update:
    x-apievangelist-phrasing:
      intent: List a task's comments and activity
      effect: read
      questions:
      - How do I read the comments and activity history on a task?
      - Can I see who changed what on a task over time?
      instructions:
      - text: List the stories on task {task}.
        slots:
          task: path.task_gid
      - text: Show the comments and activity log for task {task}.
        slots:
          task: path.task_gid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tasks/{task_gid}/stories'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on a task
      effect: write
      questions:
      - How do I post a comment on a task?
      - Who is shown as the author of a comment added through the API?
      instructions:
      - text: Comment {text} on task {task}.
        slots:
          task: path.task_gid
          text: requestBody.data
      - text: Post a comment on task {task} saying {text}.
        slots:
          task: path.task_gid
          text: requestBody.data
      method: generated
      generated: '2026-10-01'