Build docs 03-27-2024

Asana · Mar 27, 2024 · e97239a · e97239a
1 parent 553456b
commit e97239a
Show file tree

Hide file tree

Showing 2 changed files with 504 additions and 629 deletions.
diff --git a/defs/asana_oas.yaml b/defs/asana_oas.yaml
@@ -1429,44 +1429,12 @@ components:
           schema:
             $ref: '#/components/schemas/ErrorResponse'
   schemas:
-    AllocationResponse:
-      allOf:
-        - $ref: '#/components/schemas/AllocationCompact'
-        - type: object
-          properties:
-            created_by:
-              $ref: '#/components/schemas/UserCompact'
-              type: object
-              description: >-
-                The user who created the allocation.
-            resource_subtype:
-              description: The subtype of the allocation.
-              type: string
-              example: project_allocation
-    AllocationRequest:
-      allOf:
-        - $ref: '#/components/schemas/AllocationBase'
-        - type: object
-          properties:
-            assignee:
-              type: string
-              description: >-
-                Globally unique identifier for the user who is assigned to the allocation.
-            parent:
-              type: string
-              description: >-
-                Globally unique identifier for the project the allocation is on.
-            effort:
-              $ref: '#/components/schemas/EffortCompact'
-              type: object
-              description: >-
-                The amount of time associated with the allocation, represented as
-                a percentage or number of hours
-              nullable: true
     AllocationBase:
       allOf:
         - $ref: '#/components/schemas/AsanaResource'
         - type: object
+          x-docs-overrides:
+            properties.resource_type.example: allocation
           properties:
             start_date:
               type: string
@@ -1480,30 +1448,63 @@ components:
               description: >-
                 The localized day on which the allocation ends.
               example: '2024-02-28'
-    AllocationCompact:
+            effort:
+              type: object
+              nullable: true
+              description: >-
+                The amount of time associated with the allocation, represented as
+                a percentage or number of hours
+              properties:
+                type:
+                  type: string
+                  description: >-
+                    The units used for tracking effort on an allocation, either "hours"
+                    or "percent".
+                  enum:
+                    - hours
+                    - percent
+                value:
+                  type: number
+                  description: >-
+                    The numeric effort value on the allocation.
+                  example: 50
+    AllocationResponse:
       allOf:
         - $ref: '#/components/schemas/AllocationBase'
         - type: object
-          x-docs-overrides:
-            properties.resource_type.example: allocation
           properties:
             assignee:
               $ref: '#/components/schemas/UserCompact'
               type: object
               description: >-
                 The user who is assigned to the allocation.
+            created_by:
+              $ref: '#/components/schemas/UserCompact'
+              type: object
+              description: >-
+                The user who created the allocation.
             parent:
               $ref: '#/components/schemas/ProjectCompact'
               type: object
               description: >-
                 The project the allocation is on.
-            effort:
-              $ref: '#/components/schemas/EffortCompact'
-              type: object
+            resource_subtype:
+              description: The subtype of the allocation.
+              type: string
+              example: project_allocation
+    AllocationRequest:
+      allOf:
+        - $ref: '#/components/schemas/AllocationBase'
+        - type: object
+          properties:
+            assignee:
+              type: string
               description: >-
-                The amount of time associated with the allocation, represented as
-                a percentage or number of hours
-              nullable: true
+                Globally unique identifier for the user who is assigned to the allocation.
+            parent:
+              type: string
+              description: >-
+                Globally unique identifier for the project the allocation is on.
     AddCustomFieldSettingRequest:
       type: object
       required:
@@ -1856,6 +1857,17 @@ components:
     AuditLogEventDetails:
       description: Event specific details. The schema will vary depending on the `event_type`.
       type: object
+      properties:
+        old_value:
+          type: string
+          nullable: true
+        new_value:
+          type: string
+          nullable: true
+        group:
+          type: object
+          additionalProperties: true
+      additionalProperties: true
     AuditLogEventResource:
       description: The primary object that was affected by this event.
       type: object
@@ -2502,26 +2514,6 @@ components:
                   description: >-
                     The custom field that is applied to the `parent`.
                   readOnly: true
-    EffortCompact:
-      allOf:
-        - $ref: '#/components/schemas/AsanaResource'
-        - type: object
-          x-docs-overrides:
-            properties.resource_type.example: effort
-          properties:
-            type:
-              type: string
-              description: >-
-                The units used for tracking effort on an allocation, either "hours"
-                or "percent".
-              enum:
-                - hours
-                - percent
-            value:
-              type: number
-              description: >-
-                The numeric effort value on the allocation.
-              example: 50
     EmptyResponse:
       type: object
       description: >-
@@ -7102,6 +7094,7 @@ components:
               enum:
                 - commenter
                 - editor
+              deprecated: true
               example: editor
             access_level:
               type: string
@@ -7205,6 +7198,7 @@ components:
                 Can be `editor` or `commenter` for goals. Can be `admin`,`editor`
                 or `commenter` for projects.
               type: string
+              deprecated: true
               example: editor
     MembershipResponse:
       anyOf:
@@ -7849,7 +7843,14 @@ paths:
               type: object
               properties:
                 data:
-                  $ref: '#/components/schemas/AllocationRequest'
+                  allOf:
+                    - $ref: '#/components/schemas/AllocationRequest'
+                    - type: object
+                      required:
+                        - assignee
+                        - end_date
+                        - parent
+                        - start_date
       responses:
         201:
           description: Successfully created a new allocation.