Asana · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Asana Goal Relationships API

6 actions 6 updates phrasing extends openapi/asana-goal-relationships-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['/goal_relationships/{goal_relationship_gid}'].get
$.paths['/goal_relationships/{goal_relationship_gid}'].put
$.paths['/goal_relationships'].get
$.paths['/goals/{goal_gid}/addSupportingRelationship'].post
$.paths['/goals/{goal_gid}/removeSupportingRelationship'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Asana Goal Relationships API
  version: 1.0.0
extends: openapi/asana-goal-relationships-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['/goal_relationships/{goal_relationship_gid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a goal relationship
      effect: read
      questions:
      - What does a single goal relationship record include?
      - Can I see how much a supporting item contributes to a goal?
      instructions:
      - text: Show goal relationship {relationship}.
        slots:
          relationship: path.goal_relationship_gid
      - text: Fetch the details of goal relationship {relationship}.
        slots:
          relationship: path.goal_relationship_gid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/goal_relationships/{goal_relationship_gid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a goal relationship's contribution
      effect: write
      questions:
      - Can I change the contribution weight of a supporting goal?
      - Which goal relationship fields can be edited?
      instructions:
      - text: Set goal relationship {relationship} contribution weight to {weight}.
        slots:
          relationship: path.goal_relationship_gid
          weight: requestBody.data
      - text: Update goal relationship {relationship} with {changes}.
        slots:
          relationship: path.goal_relationship_gid
          changes: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/goal_relationships'].get
  update:
    x-apievangelist-phrasing:
      intent: List what supports a goal
      effect: read
      questions:
      - Which projects, portfolios or subgoals support a given goal?
      - Can I filter a goal's supporting relationships by type?
      instructions:
      - text: List the relationships supporting goal {goal}.
        slots:
          goal: query.supported_goal
      - text: Show supporting {subtype} relationships for goal {goal}.
        slots:
          goal: query.supported_goal
          subtype: query.resource_subtype
      method: generated
      generated: '2026-10-01'
- target: $.paths['/goals/{goal_gid}/addSupportingRelationship'].post
  update:
    x-apievangelist-phrasing:
      intent: Link supporting work to a goal
      effect: write
      questions:
      - How do I connect a project or subgoal so it supports a goal?
      - Can I set a contribution weight when linking supporting work?
      instructions:
      - text: Add {resource} as supporting work for goal {goal}.
        slots:
          goal: path.goal_gid
          resource: requestBody.data
      - text: Link project {resource} to support goal {goal}.
        slots:
          goal: path.goal_gid
          resource: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/goals/{goal_gid}/removeSupportingRelationship'].post
  update:
    x-apievangelist-phrasing:
      intent: Unlink supporting work from a goal
      effect: write
      questions:
      - Can I stop a project from counting toward a goal?
      - How do I detach a subgoal from its parent goal?
      instructions:
      - text: Remove {resource} as supporting work for goal {goal}.
        slots:
          goal: path.goal_gid
          resource: requestBody.data
      - text: Unlink {resource} from goal {goal}.
        slots:
          goal: path.goal_gid
          resource: requestBody.data
      method: generated
      generated: '2026-10-01'