4.0.2

Release Notes

For: uc-cdis/metadata-service

Notes since tag: 4.0.0

Notes to tag/commit: eff41c4

Generated: 2024-11-01

Improvements

• MDS search response now makes use of MDS index on the data._guid_type for
  specific commons (MIDRC) (#117)
• Google doc with the observations : [Discovery page loading issue MIDRC
  (#117)
• ](https://docs.google.com/document/d/1oCn5rNVKLcq_-6m35OjTJZhRvSPT8NICUOXzlSnX7S0/edit?usp=sharing)
  (#117)
• Sanitize path for aggregate config file (#101)

Dependency Updates

• Bumps cryptography from 42.0.8 to
  43.0.1. (#114)
• authutils to 6.2.5 (#111)
• authlib to 1.3.1 (#111)
• Bumps requests from 2.31.0 to 2.32.0.
  (#106)
• Bumps urllib3 from 1.26.18 to
  1.26.19. (#107)
• many, importantly gunicorn (#103)
• cryptography to 42.0.5 (#101)
• pyyaml to 6.0.1 (#101)

Bug Fixes

• fix token aud issue (#112)
• A limit to the amount of nested objects was created in ES7.
  elastic/elasticsearch#26962 (#100)
• In order to resolve this error from occurring when running the aggMDS job-
  we must increase this limit. (#100)

Metadata service with ES7 compatibility

Merge pull request #96 from uc-cdis/feat/es-7

feat(es7): make mds compatible with es7

3.1.0: Nested fields support

Release Notes

For: uc-cdis/metadata-service

Notes since tag: 3.0.0

Notes to tag/commit: 3.1.0

Generated: 2023-07-19

New Features

• AggMDS field mappings now support using JSON path as field names to setup
  nested object in the result (#95)

Improvements

• Updated test codes (#95)
• Log detailed authentication errors from authutils (#93)
• Set USE_AGG_MDS in the tests so that all tests pass locally out of the
  box (#87)
• The objects module checks the validity of authz values by validating
  both the version and the resource_paths (#87)

Deployment Changes

3.0.0: AggMDS VLMD Support

Release Notes

For: uc-cdis/metadata-service

Notes since tag: 2.2.0

Notes to tag/commit: 3.0.0

Generated: 2023-02-10

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

New Features

• Add VLMD support to AggMDS (#90)
• Add AGG_MDS_DEFAULT_STUDY_DATA_FIELD to MDS config to indicate the SLMD
  field name in AggMDS records, default to gen3_discovery (#90)
• Add AGG_MDS_DEFAULT_DATA_DICT_FIELD to MDS config to indicate the VLMD
  field name in AggMDS records, if available, default to None (#90)
• 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
  (#90)

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
  (#90)
• Data format of response returned from /aggregate/metadata/{name} has
  changed, please refer to the PR description and/or API docs for details
  (#90)

Deployment Changes

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

Added three new MDS DataAdapters

Release Notes

For: uc-cdis/metadata-service
Notes since tag: 2.1.0
Generated: 2023-1-10

New Features

• Add three new aggregate MDS adapters for GDC, PDC and CIDC data (#85)

Improvements

• Eliminated a few warnings related invalid operator | between 'dict' | 'dict' --> 'dict' or 'dict'

bug fixes and new adapter

Release Notes

For: uc-cdis/metadata-service
Notes since tag: 2.0.1
Notes to tag/commit: 68d489d
Generated: 2022-12-05

New Features

• Add new aggregate MDS adapter for Integrated Canine Data Commons data (#84)

Bug Fixes

• Ensure deterministic pagination by query when limit/offset is used (by
  adding an explicit ORDER BY) (#83)
• Increasing wait time for an aggregated MDS response to handle commons that
  take longer than the default 5 seconds to load. (#82)
• Adding a Null Check for tags in an entry in the aggregated response. (#82)

2.0.1: Migration edge cases fix

Release Notes

For: uc-cdis/metadata-service

Notes since tag: 2.0.0

Notes to tag/commit: 2.0.1

Generated: 2022-10-28

Bug Fixes

• fixed a bug causing DB migration to crash for special string combinations
  (#79)

2.0.0: New AggMDS config format

Release Notes

For: uc-cdis/metadata-service

Notes since tag: 1.10.0

Notes to tag/commit: 2.0.0

Generated: 2022-10-26

New Features

• Array fields can be "compressed" to return the length and not the full
  field using the counts parameter (#65)
• The elastic search index can be configured using the schema section of the
  config file (#65)
• Introspection of the schema to a JSON schema using the info/schema call
  (#65)
• Multiple adapters can write to the same common namespace; this allows for
  adapters to have more fine grain control to cherry-pick studies and store
  them in the same namespace (#65)
• Support for pagination info using the pagination=true (#65)
• Can optionally flatten the response using flatten=true (#65)
• A true Gen3 adapter replaces the older Gen3 specific loader (MDSInstance).
  This means the gen3_commons section of the config file should not be
  used. (#65)
• Optionally cache DRS prefix to hostname mapping from dataguids.org.
  Allowing the aggregate_metadata service to act as a DRS resolver. (#65)

Breaking Changes

• The configuration file is not compatible with the previous release. This is
  due to the new support for defining a schema, new configuration options,
  and changes to the adapters. (#65)

Improvements

• The ETL process (i.e. populate) now will load to a temporary index and
  clone to the live index only if no errors are encountered (#65)
• Updated documentation and sample config file (#65)
• all config file have been removed (#65)
• extend httpx and rety timeout for Gen3Adapter (#65)
• Removing Veracode scanning pipeline (#77)
• Removing Veracode scanning pipeline (#76)

Deployment Changes

• configuration files will need to be updated (#65)

New adapter class, improve migration mem usage

Release Notes

For: uc-cdis/metadata-service
Notes since tag: 1.9.0
Notes to tag/commit: 5ec1bc9
Generated: 2022-10-04

New Features

• Adds adapter class for MPS (#62)

Bug Fixes

• Removes deprecated metadata keys in rows that were missed by migration
  4d93784a25e5_add_authz_column.py.
  (#73)

Improvements

• Reduce peak memory usage in database migrations (#66)
• Documentation: add details about what MDS is, what Aggregate MDS is, and
  reorganize the documentation (#71)

Alias support

Release Notes

For: uc-cdis/metadata-service
Notes since tag: 1.8.2
Notes to tag/commit: 1cdffbb
Generated: 2022-09-15

New Features

• /alias endpoints for CRUD of Metadata Aliases (unique alternative names for
  GUIDs) (#63)

Improvements

• Better openAPI docs generation

Deployment Changes

• Database migration for MDS (#63)