Skip to content
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

Moving data model documentation into main #821

Merged
merged 2 commits into from
Nov 20, 2023
Merged

Moving data model documentation into main #821

merged 2 commits into from
Nov 20, 2023

Conversation

markpatton
Copy link
Contributor

@markpatton markpatton commented Nov 8, 2023

Ported and updated documenation from pass-data-model. Also updated the diagram.

@markpatton markpatton linked an issue Nov 8, 2023 that may be closed by this pull request
@markpatton markpatton marked this pull request as ready for review November 9, 2023 17:08
@tsande16 tsande16 self-requested a review November 20, 2023 15:17
Copy link
Contributor

@tsande16 tsande16 left a comment

Choose a reason for hiding this comment

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

Looks good! Just one question about the User model.

| lastName | String | Last name(s) of User |
| displayName | String | Name for display. Separate names may not be available, but a person should always at least have a display name. |
| email | String | Contact email for User |
| affiliation | String[] | The affiliation(s) of the User with their institution, for example `[email protected]`. An institution may have multiple organizational units, and a User may have a different affiliation with any given OU. A User having an affiliation with multiple OUs in an institution would have multiple values, for example `[email protected]` and `[email protected]`. |
Copy link
Contributor

Choose a reason for hiding this comment

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

Which table should affiliation be? I'm looking in staging at the moment and I don't see anything like pass_user_affiliation. Perhaps it should be a String and not a String array? I see for locatorIds[], there is a table for that relationship: pass_user_locators

Copy link
Contributor Author

@markpatton markpatton Nov 20, 2023

Choose a reason for hiding this comment

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

The db is not definitive for the data model. It's the Java/JSON API. We just didn't break it out because it doesn't need to be searched. It might be revisited at some point.

@markpatton markpatton merged commit 771eaa4 into main Nov 20, 2023
3 checks passed
@markpatton markpatton deleted the 725-data-model branch December 13, 2023 13:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update data model documentation and move into main repo
2 participants