capability to configure query on request

materialsproject / maggma

MongoDB aggregation machine

https://materialsproject.github.io/maggma/

Other

38 stars 31 forks source link

capability to configure query on request #985

Closed yang-ruoxi closed 1 month ago

yang-ruoxi commented 1 month ago

Summary

Major changes:

Added the capability in ReadOnlyResource for it to be able to configure query parameters based on the incoming request header.
The added arg is configure_query_on_request which defaults to None.
The abstract method configure_query_on_request lives in the HeaderProcessor class, one would rewrite it in any custom header processor, e.g. in emmet-api

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 88.83%. Comparing base (fd4d610) to head (6dcd244). Report is 12 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #985 +/- ## ========================================== + Coverage 88.76% 88.83% +0.06% ========================================== Files 46 46 Lines 3979 3985 +6 ========================================== + Hits 3532 3540 +8 + Misses 447 445 -2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

rkingsbury commented 1 month ago

Thanks @yang-ruoxi . I generally defer to @munrojm on anything API-related, but I understand he's in transition right now and I'm not sure if he's actively maintaining maggma. I'm happy to merge if you're ready; just let me know.

yang-ruoxi commented 1 month ago

hey @rkingsbury thank you! Going forward, I will be working on the API side of things, and will coordinate with you regarding merging api-related codes.

yang-ruoxi commented 1 month ago

Hi @rkingsbury I think it's good to go!