Asana · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Asana Project Briefs API

5 actions 5 updates phrasing extends openapi/asana-project-briefs-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 5

$.info

$.paths['/project_briefs/{project_brief_gid}'].get

$.paths['/project_briefs/{project_brief_gid}'].put

$.paths['/project_briefs/{project_brief_gid}'].delete

$.paths['/projects/{project_gid}/project_briefs'].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 Project Briefs API
  version: 1.0.0
extends: openapi/asana-project-briefs-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: 4
- target: $.paths['/project_briefs/{project_brief_gid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project brief
      effect: read
      questions:
      - How do I read the overview brief written for a project?
      - Can I fetch a project brief's text by its ID?
      instructions:
      - text: Show project brief {brief}.
        slots:
          brief: path.project_brief_gid
      - text: Fetch the content of project brief {brief}.
        slots:
          brief: path.project_brief_gid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/project_briefs/{project_brief_gid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a project brief
      effect: write
      questions:
      - Can I rewrite the text of a project brief?
      - Do fields left out of a brief update stay unchanged?
      instructions:
      - text: Update project brief {brief} with text {text}.
        slots:
          brief: path.project_brief_gid
          text: requestBody.data
      - text: Change the title of project brief {brief} to {title}.
        slots:
          brief: path.project_brief_gid
          title: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/project_briefs/{project_brief_gid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a project brief
      effect: destructive
      questions:
      - Can I remove the brief from a project?
      - What does deleting a project brief return?
      instructions:
      - text: Delete project brief {brief}.
        slots:
          brief: path.project_brief_gid
      - text: Remove the project brief {brief}.
        slots:
          brief: path.project_brief_gid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{project_gid}/project_briefs'].post
  update:
    x-apievangelist-phrasing:
      intent: Write a brief for a project
      effect: write
      questions:
      - How do I add an overview brief to a project?
      - Can I set a title and text for a new project brief?
      instructions:
      - text: Create a brief for project {project} with text {text}.
        slots:
          project: path.project_gid
          text: requestBody.data
      - text: Add a project brief titled {title} to project {project}.
        slots:
          project: path.project_gid
          title: requestBody.data
      method: generated
      generated: '2026-10-01'