From 90b802c6d140b340b30fddbe8090365dbee5cef9 Mon Sep 17 00:00:00 2001 From: Erazem Kokot Date: Wed, 16 Apr 2025 14:20:47 +0200 Subject: [PATCH 1/2] chore: ISS-162615 Add object member documentation https://app.devrev.ai/devrev/works/ISS-162615 --- .../airdrop/object-types/object-members.mdx | 25 +++++++++++++++++++ fern/versions/public.yml | 8 +++++- 2 files changed, 32 insertions(+), 1 deletion(-) create mode 100644 fern/docs/pages/airdrop/object-types/object-members.mdx diff --git a/fern/docs/pages/airdrop/object-types/object-members.mdx b/fern/docs/pages/airdrop/object-types/object-members.mdx new file mode 100644 index 00000000..571751be --- /dev/null +++ b/fern/docs/pages/airdrop/object-types/object-members.mdx @@ -0,0 +1,25 @@ +Object members define which users belong to which groups. + +They consist of the following fields: +- `id`: The unique identifier for the object member in the external system +- `object_id`: The unique identifier for the group in the external system +- `member_id`: The unique identifier for the user that should be added to the group +- `add_member_ids`: The list of unique identifiers for the users that should be added to the group +- `remove_member_ids`: The list of unique identifiers for the users that should be removed from the group + + +If you set the `add_member_ids` field, the `member_id` field will be ignored! +Always set either `add_member_ids` or `member_id`, but not both. + + + +`member_id` is a legacy field that, while still supported, should be avoided in favor of `add_member_ids`. +If possible, provide one object member per group, with the list of users to be added to the group. +Originally each object member was used to add a single user to a group, but that has since been +extended to support bulk addition and removal of users from a group. + + + +If the external system exposes a way to notify you of user removals from a group, set those users +in the `remove_member_ids` field. + diff --git a/fern/versions/public.yml b/fern/versions/public.yml index 58c4da24..10a5e61e 100644 --- a/fern/versions/public.yml +++ b/fern/versions/public.yml @@ -286,4 +286,10 @@ navigation: path: ../docs/pages/airdrop/data-model/permissions.mdx - page: "Mapping reasons" slug: mapping-reasons - path: ../docs/pages/airdrop/data-model/mapping-reasons.mdx \ No newline at end of file + path: ../docs/pages/airdrop/data-model/mapping-reasons.mdx + - section: Object type specifics + slug: object-types + contents: + - page: "Object members" + slug: object-members + path: ../docs/pages/airdrop/data-model/object-members.mdx From b3963c0ae82ba54bd50883bcdc8ca244cac37e7b Mon Sep 17 00:00:00 2001 From: Erazem Kokot Date: Wed, 16 Apr 2025 14:53:29 +0200 Subject: [PATCH 2/2] Update links and text --- fern/docs/pages/airdrop/supported-object-types.mdx | 8 +++----- fern/versions/public.yml | 2 +- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/fern/docs/pages/airdrop/supported-object-types.mdx b/fern/docs/pages/airdrop/supported-object-types.mdx index 48e0acc0..82dc231e 100644 --- a/fern/docs/pages/airdrop/supported-object-types.mdx +++ b/fern/docs/pages/airdrop/supported-object-types.mdx @@ -1,8 +1,6 @@ -# Supported DevRev object types for Airdrop +# DevRev object types that Airdrop can import -Last updated: _2025-04_ - -This document contains the list of all DevRev object types that are supported for Airdrop. +This document contains the list of all DevRev object types that are supported for importing using Airdrop. ## Summary @@ -1144,4 +1142,4 @@ This document contains the list of all DevRev object types that are supported fo [ ▲ top](#summary) ---- \ No newline at end of file +--- diff --git a/fern/versions/public.yml b/fern/versions/public.yml index 10a5e61e..877defed 100644 --- a/fern/versions/public.yml +++ b/fern/versions/public.yml @@ -292,4 +292,4 @@ navigation: contents: - page: "Object members" slug: object-members - path: ../docs/pages/airdrop/data-model/object-members.mdx + path: ../docs/pages/airdrop/object-types/object-members.mdx