Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ENH] Implemented pipeline_version and pipeline_name query fields #345

Merged
merged 17 commits into from
Oct 9, 2024

Conversation

rmanaem
Copy link
Collaborator

@rmanaem rmanaem commented Oct 2, 2024

Checklist

This section is for the PR reviewer

  • PR has an interpretable title with a prefix ([ENH], [FIX], [REF], [TST], [CI], [MNT], [INF], [MODEL], [DOC]) (see our Contributing Guidelines for more info)
  • PR has a label for the release changelog or skip-release (to be applied by maintainers only)
  • PR links to GitHub issue with mention Closes #XXXX
  • Tests pass
  • Checks pass

For new features:

  • Tests have been added

For bug fixes:

  • There is at least one test that would fail under the original bug conditions.

@rmanaem rmanaem added the pr-minor-breaking Feature or enhancement that breaks compatibility, will increment minor version (0.+1.0) label Oct 2, 2024
@coveralls
Copy link
Collaborator

coveralls commented Oct 2, 2024

Pull Request Test Coverage Report for Build 11260361393

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 40 of 47 (85.11%) changed or added relevant lines in 4 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-0.7%) to 95.385%

Changes Missing Coverage Covered Lines Changed/Added Lines %
app/api/utility.py 4 6 66.67%
app/api/crud.py 1 6 16.67%
Totals Coverage Status
Change from base Build 11127997371: -0.7%
Covered Lines: 744
Relevant Lines: 780

💛 - Coveralls

@alyssadai alyssadai self-requested a review October 3, 2024 15:49
Copy link
Contributor

@alyssadai alyssadai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for the PR @rmanaem!

The new query params look good overall, though I realized during my review that some aspects of the desired query response might still need clarifying, which I tried to do in my comments.

This made me think: maybe we can have a chat about how to ensure we're all on the same page regarding new neuroimaging data properties, as I understand some of this is domain-specific, and possibly hard to intuit. Maybe during the issue spec stage, we can look at more examples of possible forms the input (e.g., derived) metadata can take, and write up a mock example response (which I think we've done a couple times when changing the data model?)

Let me know if you need more clarification on any of the points below!

app/api/crud.py Outdated Show resolved Hide resolved
app/api/crud.py Outdated Show resolved Hide resolved
app/api/crud.py Outdated Show resolved Hide resolved
app/api/crud.py Outdated Show resolved Hide resolved
app/api/crud.py Outdated Show resolved Hide resolved
app/api/utility.py Outdated Show resolved Hide resolved
app/api/utility.py Outdated Show resolved Hide resolved
app/api/utility.py Outdated Show resolved Hide resolved
tests/test_query.py Outdated Show resolved Hide resolved
tests/test_query.py Show resolved Hide resolved
@rmanaem rmanaem requested a review from alyssadai October 9, 2024 12:03
Copy link
Contributor

@alyssadai alyssadai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good @rmanaem! I left one sanity check question for myself, and a few 🍒

Have a look, and then 🧑‍🍳

app/api/crud.py Outdated Show resolved Hide resolved
app/api/crud.py Outdated Show resolved Hide resolved
app/api/crud.py Outdated Show resolved Hide resolved
app/api/crud.py Show resolved Hide resolved
app/api/utility.py Outdated Show resolved Hide resolved
tests/test_query.py Outdated Show resolved Hide resolved
app/api/crud.py Show resolved Hide resolved
@rmanaem rmanaem merged commit a93d476 into main Oct 9, 2024
7 checks passed
@rmanaem rmanaem deleted the feat-341 branch October 9, 2024 17:53
Copy link

🚀 PR was released in v0.4.0 🚀

@neurobagel-bot neurobagel-bot bot added the released This issue/pull request has been released. label Oct 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-minor-breaking Feature or enhancement that breaks compatibility, will increment minor version (0.+1.0) released This issue/pull request has been released.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow querying for pipeline name and version
3 participants