scitran / core

RESTful API

https://scitran.github.io

MIT License

18 stars 18 forks source link

Create list of formalized top-level info keys that will always be returned #1038

Closed nagem closed 6 years ago

nagem commented 6 years ago

Some top-level keys have special meaning in the info dictionary on objects and files. This PR allows a static list of info keys through on list endpoints. Kept simple until more nuance (project/site level options) is necessary.

Review Checklist

Tests were added to cover all code changes
Documentation was added / updated
Code and tests follow standards in CONTRIBUTING.md

codecov-io commented 6 years ago

Codecov Report

:exclamation: No coverage uploaded for pull request base (master@414ee71). Click here to learn what that means. The diff coverage is 100%.

@@            Coverage Diff            @@
##             master    #1038   +/-   ##
=========================================
  Coverage          ?   90.73%           
=========================================
  Files             ?       50           
  Lines             ?     6862           
  Branches          ?        0           
=========================================
  Hits              ?     6226           
  Misses            ?      636           
  Partials          ?        0

nagem commented 6 years ago

Speaking offline with creator of content in BIDS keys, they will never contain PHI and there are too many for it to be reasonable to filter. I would prefer if new keys would be an "all or nothing" top level key as well.