Skip to content

Commit 9a477a7

Browse files
Automated build docs: 2026-02-03 01:16:45
1 parent cc0fa70 commit 9a477a7

3 files changed

Lines changed: 681 additions & 178 deletions

File tree

defs/asana_oas.yaml

Lines changed: 60 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -679,7 +679,7 @@ tags:
679679
- name: Memberships
680680
description: |-
681681
A membership object represents the relationship between a team or user and an object in Asana. Currently, the
682-
supported types of memberships are for goals, projects, and portfolios. For example, a project membership
682+
supported types of memberships are for goals, projects, custom fields, custom types,and portfolios. For example, a project membership
683683
can be used to add a user to a project.
684684
- name: Organization exports
685685
description: >-
@@ -4185,6 +4185,7 @@ components:
41854185
- $ref: '#/components/schemas/ProjectMembershipCompactResponse'
41864186
- $ref: '#/components/schemas/PortfolioMembershipCompactResponse'
41874187
- $ref: '#/components/schemas/CustomFieldMembershipCompact'
4188+
- $ref: '#/components/schemas/CustomTypeMembershipCompact'
41884189
ModifyDependenciesRequest:
41894190
type: object
41904191
properties:
@@ -5143,6 +5144,52 @@ components:
51435144
example: admin
51445145
CustomFieldMembershipResponse:
51455146
$ref: '#/components/schemas/CustomFieldMembershipBase'
5147+
CustomTypeMembershipBase:
5148+
$ref: '#/components/schemas/CustomTypeMembershipCompact'
5149+
CustomTypeMembershipCompact:
5150+
description: >-
5151+
This object describes a user or team's membership to a custom type including
5152+
their level of access (Admin, Editor, User, or Viewer).
5153+
type: object
5154+
properties:
5155+
gid:
5156+
description: >-
5157+
Globally unique identifier of the resource, as a string.
5158+
type: string
5159+
readOnly: true
5160+
example: '12345'
5161+
x-insert-after: false
5162+
resource_type:
5163+
description: The base type of this resource.
5164+
type: string
5165+
readOnly: true
5166+
example: custom_type_membership
5167+
x-insert-after: gid
5168+
resource_subtype:
5169+
description: Type of the membership.
5170+
type: string
5171+
example: custom_type_membership
5172+
parent:
5173+
description: >-
5174+
The custom type the user or team is a member of.
5175+
$ref: '#/components/schemas/CustomTypeCompact'
5176+
member:
5177+
description: Member can be a user or a team.
5178+
$ref: '#/components/schemas/MemberCompact'
5179+
access_level:
5180+
description: >-
5181+
Whether the member has admin, editor, user, or viewer
5182+
access to the custom type.
5183+
type: string
5184+
enum:
5185+
- admin
5186+
- editor
5187+
- user
5188+
- viewer
5189+
readOnly: true
5190+
example: admin
5191+
CustomTypeMembershipResponse:
5192+
$ref: '#/components/schemas/CustomTypeMembershipBase'
51465193
ProjectMembershipBase:
51475194
$ref: '#/components/schemas/ProjectMembershipCompact'
51485195
ProjectMembershipCompact:
@@ -9086,6 +9133,7 @@ components:
90869133
- $ref: '#/components/schemas/ProjectMembershipCompactResponse'
90879134
- $ref: '#/components/schemas/PortfolioMembershipResponse'
90889135
- $ref: '#/components/schemas/CustomFieldMembershipResponse'
9136+
- $ref: '#/components/schemas/CustomTypeMembershipResponse'
90899137
UpdateTimeTrackingEntryRequest:
90909138
type: object
90919139
properties:
@@ -20764,9 +20812,10 @@ paths:
2076420812
summary: Get multiple memberships
2076520813
description: >-
2076620814
Returns compact `goal_membership`, `project_membership`, `portfolio_membership`,
20767-
or `custom_field_membership` records. The possible types
20768-
for `parent` in this request are `goal`, `project`, `portfolio`, or `custom_field`.
20769-
An additional member (user GID or
20815+
`custom_type_membership`, or `custom_field_membership` records. The possible
20816+
types
20817+
for `parent` in this request are `goal`, `project`, `portfolio`, `custom_type`,
20818+
or `custom_field`. An additional member (user GID or
2077020819
team GID) can be passed in to filter to a specific membership.
2077120820

2077220821

@@ -20782,7 +20831,8 @@ paths:
2078220831
- name: parent
2078320832
in: query
2078420833
description: >-
20785-
Globally unique identifier for `goal`, `project`, `portfolio`, or `custom_field`.
20834+
Globally unique identifier for `goal`, `project`, `portfolio`, `custom_type`,
20835+
or `custom_field`.
2078620836
This parameter is optional when `resource_subtype` is provided along with
2078720837
`member`.
2078820838
schema:
@@ -20968,7 +21018,7 @@ paths:
2096821018
post:
2096921019
summary: Create a membership
2097021020
description: |-
20971-
Creates a new membership in a `goal`, `project`, `portfolio`, or `custom_field`, where members can be Teams or Users.
21021+
Creates a new membership in a `goal`, `project`, `portfolio`, `custom_type`, or `custom_field`, where members can be Teams or Users.
2097221022

2097321023
Returns the full record of the newly created membership.
2097421024
tags:
@@ -21114,7 +21164,8 @@ paths:
2111421164
summary: Get a membership
2111521165
description: >-
2111621166
Returns a `project_membership`, `goal_membership`, `portfolio_membership`,
21117-
or `custom_field_membership` record for a membership id.
21167+
`custom_type_membership`, or `custom_field_membership` record for a membership
21168+
id.
2111821169
tags:
2111921170
- Memberships
2112021171
operationId: getMembership
@@ -21216,7 +21267,7 @@ paths:
2121621267
summary: Update a membership
2121721268
description: |-
2121821269
An existing membership can be updated by making a `PUT` request on the membership. Only the fields provided in the `data` block will be updated;
21219-
any unspecified fields will remain unchanged. Memberships on `goals`, `projects`, `portfolios`, and `custom_fields` can be updated.
21270+
any unspecified fields will remain unchanged. Memberships on `goals`, `projects`, `portfolios`, `custom_types`, and `custom_fields` can be updated.
2122021271

2122121272
Returns the full record of the updated membership.
2122221273
tags:
@@ -21356,7 +21407,7 @@ paths:
2135621407
delete:
2135721408
summary: Delete a membership
2135821409
description: |-
21359-
A specific, existing membership for a `goal`, `project`, `portfolio` or `custom_field` can be deleted by making a `DELETE` request
21410+
A specific, existing membership for a `goal`, `project`, `portfolio`, `custom_type`, or `custom_field` can be deleted by making a `DELETE` request
2136021411
on the URL for that membership.
2136121412

2136221413
Returns an empty data record.

0 commit comments

Comments
 (0)