[api] Add cohorts to project info #8774
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
driusan
added
Add to Release Notes
xlecours
reviewed
Jun 12, 2023
driusan
force-pushed
the
APIProjectCohorts
branch
2 times, most recently
from
1fa3f7e
to
32552d3
Compare
driusan
added
the
Blocked
|
This should probably not go in without #8778. Might wait until after the release. |
driusan
removed
the
Blocked
driusan
force-pushed
the
APIProjectCohorts
branch
from
32552d3
to
379e286
Compare
The API documentation says you can create a visit by sending a PUT request to the visit label including all of the visit meta data that the endpoint returns, but there's no way to get a list of cohorts which is part of the required data for creating a new visit. This makes the following changes to v0.0.4-dev in order to support the creation of visits through the API without resorting to out-of-band information: 1. Adds cohorts to /projects/$projectname (similarly to how there's a visits key) 2. Renames the "Battery" key to "Cohort" in v0.0.4-dev (since it's no longer a SubprojectID in LORIS.) Ideally, cohorts would be more comprehensively supported by the API, but this is the minimal that seems to be required in order to create visits through the API and is consistent with how projects visits are handled.
driusan
force-pushed
the
APIProjectCohorts
branch
from
379e286
to
b54d680
Compare
xlecours
reviewed
Aug 8, 2023
driusan
force-pushed
the
APIProjectCohorts
branch
from
cf5fc3d
to
6e5bf86
Compare
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The API documentation says you can create a visit by sending a PUT request to the visit label including all of the visit meta data that the endpoint returns, but there's no way to get a list of cohorts which is part of the required data for creating a new visit.
This makes the following changes to v0.0.4-dev in order to support the creation of visits through the API without resorting to out-of-band information:
Ideally, cohorts would be more comprehensively supported by the API, but this is the minimal that seems to be required in order to create visits through the API and is consistent with how projects visits are handled.