Skip to content

Releases: neurobagel/api

v0.5.0

16 Dec 22:41
Compare
Choose a tag to compare

πŸš€ Enhancements

Authors: 1

v0.4.3

02 Dec 23:28
Compare
Choose a tag to compare

🏠 Internal

  • [REF] Manually verify ID token using PyJWT instead of google_auth #386 (@alyssadai)

Authors: 1

v0.4.2

07 Nov 16:07
Compare
Choose a tag to compare

πŸš€ Enhancements

  • [FIX] Filter for only ImagingSessions or PhenotypicSessions in SPARQL query #375 (@alyssadai)

Authors: 1

v0.4.1

29 Oct 00:57
Compare
Choose a tag to compare

πŸ› Bug Fixes

  • [FIX] Ensure non-agg API doesn't error out when all matches lack pipeline data #369 (@alyssadai)

πŸ§ͺ Tests

  • [TST] Remove unneeded env file mount from test docker-compose.yml #366 (@alyssadai)

Authors: 1

v0.4.0

24 Oct 19:35
Compare
Choose a tag to compare

πŸ’₯ Breaking Changes

  • [REF] Split generic /attributes endpoints into attribute-specific routers #358 (@alyssadai)
  • [ENH] Implemented pipeline_version and pipeline_name query fields #345 (@rmanaem)

πŸš€ Enhancements

  • [ENH] Add /pipelines router & route for fetching available pipeline versions #350 (@alyssadai)
  • [REF] Update README links and simplify Docker Compose instructions #340 (@alyssadai)

πŸ› Bug Fixes

  • [FIX] Allow only "true" or None for is_control query parameter #364 (@alyssadai)
  • [FIX] Fixed a typo in filtering pipeline name #351 (@rmanaem)
  • [FIX] Ensure pipeline variables are returned from the graph in an aggregate query #349 (@alyssadai)

🏠 Internal

  • [MNT] Updated default_neurobagel_query #347 (@rmanaem)
  • [MNT] Removed build docker nightly workflow file #342 (@rmanaem)

πŸ“ Documentation

  • [MNT] Update default Neurobagel SPARQL query file and turn into PR checkbox #359 (@alyssadai)

πŸ§ͺ Tests

Authors: 3

v0.3.1

13 Aug 20:49
Compare
Choose a tag to compare

πŸ› Bug Fixes

  • [FIX] Ensure subjects without imaging sessions are considered in main query #333 (@alyssadai)

🏠 Internal

  • [CI] Fix reference for DOCKERHUB_REPO in build_docker_on_release.yml #337 (@alyssadai)

Authors: 1

v0.3.0

02 Aug 16:01
Compare
Choose a tag to compare

πŸ’₯ Breaking Changes

  • [FIX] Disable redirect slashes globally and remove trailing / from /query #328 (@alyssadai)
  • [ENH] Add authentication to /query route #323 (@alyssadai)

πŸ› Bug Fixes

  • [FIX] Exclude sessions missing a queried property from matches #326 (@alyssadai)

Authors: 1

v0.2.1

16 Apr 20:20
Compare
Choose a tag to compare

πŸ› Bug Fixes

  • [FIX] Address performance issues in SPARQL query #308 (@surchs)
  • [FIX] Disable timeout for request to graph #305 (@alyssadai)

Authors: 2

v0.2.0

11 Apr 19:37
Compare
Choose a tag to compare

πŸŽ‰ This release contains work from a new contributor! πŸŽ‰

Thank you, Abdul Samad Siddiqui (@samadpls), for all your work!

Release Notes

[MNT] Release new data model (#300)

We have updated the Neurobagel data model to allow users to specify phenotypic information at the session level (neurobagel/planning#83). This release updates the node API so it can understand the new graph data.


πŸ’₯ Breaking Changes

  • [REF] Make session count names clearer in query response #282 (@alyssadai)
  • [ENH] Support queries of session-level phenotypic attributes #264 (@alyssadai)

πŸš€ Enhancements

  • [ENH] Added root endpoint with welcome message and API docs link #286 (@samadpls)
  • [MNT] Release new data model #300 (@surchs)
  • Delete .github/workflows/add_pr2project.yml #244 (@surchs)

πŸ“ Documentation

  • [DOC] Added warning about quoting in .env file for Docker commands #284 (@samadpls)
  • [DOC] Add sample default SPARQL query to repo #277 (@alyssadai)

πŸ§ͺ Tests

πŸ”© Dependency Updates

  • Bumped fastapi, starlette, and typing_extensions #295 (@rmanaem)

Authors: 4

v0.1.1

07 Dec 20:00
70d92cb
Compare
Choose a tag to compare

Summary

This release introduces new API endpoints which return:

  • queryable Neurobagel variables/attributes
  • available instances of a specific Neurobagel attribute in the linked graph
  • all term IDs and associated human-readable labels of concepts from the vocabulary used for a given Neurobagel attribute

The release also introduces:

  • greater configurability of API and graph server parameters via environment variables
  • a helper shell script for automatically uploading graph-ready data (JSONLD/TTL) to an existing graph database
  • returning sizes of matching datasets in the API response for a subject query

What's Changed

New or improved features ✨

  • [ENH] Increase configurability of API/graph server parameters by @alyssadai in #146
  • [ENH] Add environment variable for allowed origins for CORS by @alyssadai in #151
  • [ENH] Add query tool to docker compose by @surchs in #154
  • [FEAT] Add script to upload data to graph by @alyssadai in #156
  • [ENH] Implemented endpoint for returning available termURLs by @rmanaem in #183
  • [ENH] Add Neurobagel vocab graph file by @alyssadai in #184
  • [ENH] Update aggregate response body by @alyssadai in #193
  • [ENH] Add endpoint returning queryable attributes + refine existing endpoint for attribute instances by @alyssadai in #194
  • [ENH] Update add_data_to_graph.sh to also upload TTL files by @alyssadai in #196
  • [ENH] Add endpoint that returns term ID-label mappings for vocab of a given attribute (nb:Assessment) by @alyssadai in #201
  • [ENH] Make data upload script backend responsive by @alyssadai in #205
  • [ENH] Return human-readable labels (if available) as well as term IDs from /attributes/{data_element_URI} by @alyssadai in #218
  • [ENH] Changed the favicon to neurobagel logo by @rmanaem in #222
  • [ENH] Return dataset sizes in query response by @alyssadai in #223
  • [ENH] Add support for endpoint that will return nb:Diagnosis options from SNOMED by @alyssadai in #228

Data model-related updates βš™οΈ

  • [MNT] Add NCIT namespace and update healthy control term by @alyssadai in #181
  • [FIX] Make session optional in SPARQL query template by @alyssadai in #229

Documentation updates πŸ“œ

  • [REF] Remove environment variable table from README by @alyssadai in #168
  • [DOC] Generalized environment variables' table by @rmanaem in #198
  • [DOC] Add link to official docs by @surchs in #219

Bug fixes πŸ› οΈ

  • [FIX] Fix typo in .template-env by @alyssadai in #149
  • [FIX] Remove yaml list key for API_QUERY_URL by @surchs in #164
  • [FIX] Properly expose NB_GRAPH_PORT_HOST to API container by @alyssadai in #167
  • [FIX] Removed the nested variable for API_QUERY_URL env var by @rmanaem in #177
  • [FIX] Properly expose NB_GRAPH_PORT to API container by @rmanaem in #191
  • [FIX] Remove --no-progress-meter by @surchs in #227
  • [FIX] Copy vocab/ directory into container filesystem in Dockerfile by @alyssadai in #231
  • [FIX] Filtered out null imaging modalities by @rmanaem in #233
  • [FIX] Remove query tool config by @surchs in #238

Other changes 🧹

  • [MNT] Added docker-pre-commit pre-commit hook by @rmanaem in #178
  • [REF] Refactor httpx.post call to Stardog and context creation by @alyssadai in #195
  • [MNT] Removed session_file_path from aggregate results by @rmanaem in #214
  • [REF] Organize related tests into modules and refactor setting of toy credentials by @alyssadai in #220
  • [REF] Refactor dataset size request into separate function by @alyssadai in #235
  • [CI] Renamed ci workflow to build_docker and image tag from latest to nightly by @rmanaem in #242
  • [CI] Add workflow for building image on release by @alyssadai in #243

New Contributors

Full Changelog: v0.1.0...v0.1.1