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

HP-1044 Feat/aggmds vlmd #90

Merged
merged 17 commits into from
Feb 11, 2023
Merged

HP-1044 Feat/aggmds vlmd #90

merged 17 commits into from
Feb 11, 2023

Conversation

mfshao
Copy link
Contributor

@mfshao mfshao commented Feb 1, 2023

Jira Ticket: HP-1044

⚠️ Important: After deploy this version of MDS, if you are using AggMDS, you are required to run AggMDS sync to migrate the AggMDS records syntax

Add variable-level metadata (VLMD) support to AggMDS

Currently AggMDS can only pull in study-level metadata (SLMD)

All AggMDS endpoints should be backward-compatible except for the following: /aggregate/metadata/guid/{guid} and /aggregate/metadata/{name}

Perviously these 2 endpoint will only return SLMD

{
  ...SLMD content
}

Now they will return both SLMD and VLMD (if exists) and their correspoiding parent, in the format of

{
  "gen3_discovery": {
     ...SLMD content
  },
  "data_dictionaries": {
     ...VLMD content
  }
}

New Features

  • Add VLMD support to AggMDS
  • Add AGG_MDS_DEFAULT_STUDY_DATA_FIELD to MDS config to indicate the SLMD field name in AggMDS records, default to gen3_discovery
  • Add AGG_MDS_DEFAULT_DATA_DICT_FIELD to MDS config to indicate the VLMD field name in AggMDS records, if available, default to None
  • Add data_dict_field to AggMDS adatper config to indicate the VLMD field name in metadata that will be populated into AggMDS, this field is optional

Breaking Changes

  • Data format of response returned from /aggregate/metadata/guid/{guid} has changed, please refer to the PR description and/or API docs for details
  • Data format of response returned from /aggregate/metadata/{name} has changed, please refer to the PR description and/or API docs for details

Deployment changes

  • Envs using AggMDS before must run the AggMDS sync job after updating to this version to migrate AggMDS reocrds syntax

@github-actions
Copy link

github-actions bot commented Feb 1, 2023

The style in this PR agrees with black. ✔️

This formatting comment was generated automatically by a script in uc-cdis/wool.

@mfshao mfshao marked this pull request as ready for review February 2, 2023 03:33
Copy link
Member

@MichaelLukowski MichaelLukowski 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, I don't see any issues

This was referenced Apr 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants