Merge pull request #55 from Asana/build-docs-12-1-2023

build docs 12/01/2023

defs/asana_oas.yaml

@@ -555,7 +555,7 @@ tags:
   - name: Goal relationships
     description: >-
       A goal relationship is an object representing the relationship between a goal
-      and another goal, a project, or a portfolio.
+      and another goal, a project, a task, or a portfolio.
   - name: Jobs
     description: >-
       Jobs represent processes that handle asynchronous work. A job created when an
@@ -2692,7 +2692,7 @@ components:
       properties:
         supporting_work:
           description: >-
-            The project/portfolio gid to add as supporting work for a goal
+            The project/task/portfolio gid to add as supporting work for a goal
           type: string
           example: '1331'
     GoalBase:
@@ -2835,7 +2835,8 @@ components:
                 This field defines how the progress value of a goal metric is being
                 calculated.
                 A goal's progress can be provided manually by the user,
-                calculated automatically from contributing subgoals or projects,
+                calculated automatically from contributing subgoals, projects, or
+                tasks,
                 or managed by an integration with an external data source, such as
                 Salesforce.
               type: string
@@ -2844,6 +2845,7 @@ components:
                 - subgoal_progress
                 - project_task_completion
                 - project_milestone_completion
+                - task_completion
                 - external
               example: manual
     GoalRemoveSupportingRelationshipRequest:
@@ -2854,7 +2856,7 @@ components:
         supporting_resource:
           description: >-
             The gid of the supporting resource to remove from the parent goal. Must
-            be the gid of a goal, project, or portfolio.
+            be the gid of a goal, project, task, or portfolio.
           type: string
           example: '12345'
     GoalAddSupportingRelationshipRequest:
@@ -2865,7 +2867,7 @@ components:
         supporting_resource:
           description: >-
             The gid of the supporting resource to add to the parent goal. Must be
-            the gid of a goal, project, or portfolio.
+            the gid of a goal, project, task, or portfolio.
           type: string
           example: '12345'
         insert_before:
@@ -3068,7 +3070,7 @@ components:
         - type: object
           description: >-
             A *goal relationship* is an object representing the relationship between
-            a goal and another goal, a project, or a portfolio.
+            a goal and another goal, a project, a task, or a portfolio.
           x-docs-overrides:
             properties.resource_type.example: goal_relationship
           properties:
@@ -3090,7 +3092,7 @@ components:
                   readOnly: true
                   description: >-
                     The supporting resource that supports the goal. This can be either
-                    a project, portfolio, or goal.
+                    a project, task, portfolio, or goal.
             contribution_weight:
               description: The weight that the supporting resource's progress contributes
                 to the supported goal's progress. This can only be 0 or 1.
@@ -12269,6 +12271,12 @@ paths:
           schema:
             type: string
           example: '512241'
+        - name: task
+          in: query
+          description: Globally unique identifier for supporting task.
+          schema:
+            type: string
+          example: '78424'
         - name: is_workspace_level
           in: query
           description: Filter to goals with is_workspace_level set to query value.

defs/asana_sdk_oas.yaml

@@ -555,7 +555,7 @@ tags:
   - name: Goal relationships
     description: >-
       A goal relationship is an object representing the relationship between a goal
-      and another goal, a project, or a portfolio.
+      and another goal, a project, a task, or a portfolio.
   - name: Jobs
     description: >-
       Jobs represent processes that handle asynchronous work. A job created when an
@@ -6127,7 +6127,7 @@ components:
       properties:
         supporting_work:
           description: >-
-            The project/portfolio gid to add as supporting work for a goal
+            The project/task/portfolio gid to add as supporting work for a goal
           type: string
           example: '1331'
     GoalBase:
@@ -6330,14 +6330,15 @@ components:
           description: >-
             This field defines how the progress value of a goal metric is being calculated.
             A goal's progress can be provided manually by the user,
-            calculated automatically from contributing subgoals or projects,
+            calculated automatically from contributing subgoals, projects, or tasks,
             or managed by an integration with an external data source, such as Salesforce.
           type: string
           enum:
             - manual
             - subgoal_progress
             - project_task_completion
             - project_milestone_completion
+            - task_completion
             - external
           example: manual
     GoalRemoveSupportingRelationshipRequest:
@@ -6348,7 +6349,7 @@ components:
         supporting_resource:
           description: >-
             The gid of the supporting resource to remove from the parent goal. Must
-            be the gid of a goal, project, or portfolio.
+            be the gid of a goal, project, task, or portfolio.
           type: string
           example: '12345'
     GoalAddSupportingRelationshipRequest:
@@ -6359,7 +6360,7 @@ components:
         supporting_resource:
           description: >-
             The gid of the supporting resource to add to the parent goal. Must be
-            the gid of a goal, project, or portfolio.
+            the gid of a goal, project, task, or portfolio.
           type: string
           example: '12345'
         insert_before:
@@ -6491,14 +6492,15 @@ components:
           description: >-
             This field defines how the progress value of a goal metric is being calculated.
             A goal's progress can be provided manually by the user,
-            calculated automatically from contributing subgoals or projects,
+            calculated automatically from contributing subgoals, projects, or tasks,
             or managed by an integration with an external data source, such as Salesforce.
           type: string
           enum:
             - manual
             - subgoal_progress
             - project_task_completion
             - project_milestone_completion
+            - task_completion
             - external
           example: manual
     GoalRemoveSubgoalRequest:
@@ -7133,7 +7135,8 @@ components:
                 This field defines how the progress value of a goal metric is being
                 calculated.
                 A goal's progress can be provided manually by the user,
-                calculated automatically from contributing subgoals or projects,
+                calculated automatically from contributing subgoals, projects, or
+                tasks,
                 or managed by an integration with an external data source, such as
                 Salesforce.
               type: string
@@ -7142,6 +7145,7 @@ components:
                 - subgoal_progress
                 - project_task_completion
                 - project_milestone_completion
+                - task_completion
                 - external
               example: manual
             can_manage:
@@ -7258,7 +7262,7 @@ components:
         Asana Resource, containing a globally unique identifier.
 
         A *goal relationship* is an object representing the relationship between a
-        goal and another goal, a project, or a portfolio.
+        goal and another goal, a project, a task, or a portfolio.
       type: object
       properties:
         gid:
@@ -7303,7 +7307,7 @@ components:
             or organization, depending on its permissions.
 
             The supporting resource that supports the goal. This can be either a project,
-            portfolio, or goal.
+            task, portfolio, or goal.
           type: object
           properties:
             gid:
@@ -7397,7 +7401,7 @@ components:
         Asana Resource, containing a globally unique identifier.
 
         A *goal relationship* is an object representing the relationship between a
-        goal and another goal, a project, or a portfolio.
+        goal and another goal, a project, a task, or a portfolio.
       type: object
       properties:
         gid:
@@ -7442,7 +7446,7 @@ components:
             or organization, depending on its permissions.
 
             The supporting resource that supports the goal. This can be either a project,
-            portfolio, or goal.
+            task, portfolio, or goal.
           type: object
           properties:
             gid:
@@ -7479,7 +7483,7 @@ components:
         Asana Resource, containing a globally unique identifier.
 
         A *goal relationship* is an object representing the relationship between a
-        goal and another goal, a project, or a portfolio.
+        goal and another goal, a project, a task, or a portfolio.
       type: object
       properties:
         gid:
@@ -7524,7 +7528,7 @@ components:
             or organization, depending on its permissions.
 
             The supporting resource that supports the goal. This can be either a project,
-            portfolio, or goal.
+            task, portfolio, or goal.
           type: object
           properties:
             gid:
@@ -7617,7 +7621,7 @@ components:
         Asana Resource, containing a globally unique identifier.
 
         A *goal relationship* is an object representing the relationship between a
-        goal and another goal, a project, or a portfolio.
+        goal and another goal, a project, a task, or a portfolio.
       type: object
       properties:
         gid:
@@ -7662,7 +7666,7 @@ components:
             or organization, depending on its permissions.
 
             The supporting resource that supports the goal. This can be either a project,
-            portfolio, or goal.
+            task, portfolio, or goal.
           type: object
           properties:
             gid:
@@ -32033,6 +32037,12 @@ paths:
           schema:
             type: string
           example: '512241'
+        - name: task
+          in: query
+          description: Globally unique identifier for supporting task.
+          schema:
+            type: string
+          example: '78424'
         - name: is_workspace_level
           in: query
           description: Filter to goals with is_workspace_level set to query value.