Skip to content

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions fern/docs/pages/airdrop/object-types/object-members.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
Object members define which users belong to which groups.
Copy link
Contributor

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."


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>
8 changes: 3 additions & 5 deletions fern/docs/pages/airdrop/supported-object-types.mdx
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [EkLine] reported by reviewdog 🐶

'Key Capabilities' should use sentence-style capitalization. (EK00037)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [EkLine] reported by reviewdog 🐶

'account' should use sentence-style capitalization. (EK00037)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [EkLine] reported by reviewdog 🐶

'postal_address' should use sentence-style capitalization. (EK00037)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [EkLine] reported by reviewdog 🐶

'airdrop_authorization_policy' should use sentence-style capitalization. (EK00037)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [EkLine] reported by reviewdog 🐶

'airdrop_platform_group' should use sentence-style capitalization. (EK00037)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [EkLine] reported by reviewdog 🐶

'article' should use sentence-style capitalization. (EK00037)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [EkLine] reported by reviewdog 🐶

Consider using 'customer' instead of 'Rev'. (EK25033)

| `shared_with` | permission (collection) | | The list of Rev user, groups and dynamic groups with whom the article is shared and the corresponding roles. |

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [EkLine] reported by reviewdog 🐶

'resource' should use sentence-style capitalization. (EK00037)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [EkLine] reported by reviewdog 🐶

Use 'DevRev' instead of 'devrev'. (EK25050)

| `content_blocks` | reference | | Content blocks used in the article (relevant only for devrev/rt articles). |

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [EkLine] reported by reviewdog 🐶

'capability' should use sentence-style capitalization. (EK00037)

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

Copy link
Contributor

Choose a reason for hiding this comment

The 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
# 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

Expand Down Expand Up @@ -1144,4 +1142,4 @@ This document contains the list of all DevRev object types that are supported fo

[ ▲ top](#summary)

---
---
8 changes: 7 additions & 1 deletion fern/versions/public.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
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/object-types/object-members.mdx
Loading