-
Notifications
You must be signed in to change notification settings - Fork 3
chore: ISS-162615 Add object member documentation #212
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
|
||
<Warning> | ||
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. | ||
</Warning> | ||
|
||
<Info> | ||
`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. | ||
</Info> | ||
|
||
<Info> | ||
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. | ||
</Info> |
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [EkLine] reported by reviewdog 🐶
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
Original file line number | Diff line number | Diff line change | ||
---|---|---|---|---|
@@ -1,8 +1,6 @@ | ||||
# Supported DevRev object types for Airdrop | ||||
# DevRev object types that Airdrop can import | ||||
|
||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Page titles come from public.yml. Having an H1 in the page itself creates a redundant heading.
Suggested change
|
||||
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) | ||||
|
||||
--- | ||||
--- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"
Object members
object type lists users that belong to a single group."