v1.0.0-rc.1

v1.0.0-rc.1 — 04-26-2024

Added

• Adds an endpoint to show an individual file (link to card, #82).
• Adds an endpoint to partition files by metadata elements and namespace (link to card, #82).
• Adds support for reporting the metadata fields for file at /metadata/file/fields (link to card, #82).
• Nine new metadata elements were added (#89 and #91).
  • The library strategy for the sample (CDE 6273393 v1.00, #48)
  • The preservation method for the sample's biospecimen (CDE 8028962 v2.00, #64)
  • Disease at diagnosis (unaligned, #52).
  • A short title for a study (CDE 11459812 v1.00, #69).
  • A funding id for a study (CDE 14528051 v1.00, #66).
  • An identifier for a study (CDE 12960571 v1.00, #70).
  • A name for a study (CDE 11459810 v1.00, #68).
  • Institution (CDE 12662779 v1.00, #67).
  • dbGaP phs Accession (CDE 11524544 v1.00, #65).

Changed

• Revises the data model for files to more closely match subjects and samples by adding a ccdi_server::responses::File object (#82).
• Ensures that all primary entities must explicitly exclude missing metadata objects for primary entities (subject, sample, and file) by assigning it a value of null rather than simply omitting the key (#84).
• Revises the way missing or null results are displayed in group by endpoints. In particular, there is now a top-level missing key in those responses rather than using sentinel values to indicate missing data (#83).
• Clarifies the language regarding the meaning of null within the API including guidance on when to return null and how to interpret null results (particularly when combined with enumerated values of CDEs that appear to overlap with this concept) (#81).

Fixed

• Adds filtering to the /file endpoint (#88).