Closed noctera closed 1 year ago
If have updated all routes, everything should work. I will just do some code cleanup and refactoring I just have a small topic I want to discuss. With this PR I have built in the functionality for "Custom Learning". Now you will have the option to get every vocab card from one or multiple specific groups in your query. But as far as it is implemented now, this includes unactivated vocabs too, which will be given back. Do you think we should exclude those for custom learning, as they have not been activated yet?
This is just a question for this temporarily setup. I would say we implement the full Custom Learning features later, as this is something like a test drive which will be available because it is made available through another function we built
Description
This PR will be the basis for the upcoming PR in the Frontend (issued here vocascan/vocascan-frontend#132). I updated the routes to return groups and vocabs that contain staged vocabs.
Updated GET group route GET
/api/languagePackage/:languagePackageId/group
Added query parameter?onlyStaged=true
to only return groups that contain at least one unactivated/staged vocab Added query parameter?onlyActivated=true
to only return groups that contain at least one active vocabUpdated GET language package route GET
/api/languagePackage/
Added query parameter?onlyActivated=true
to only return language packages that contain at least one group with at least one active vocabUpdate GET query route GET
/languagePackage/:languagePackageId/query
Add query parameter?groupId={groupId}&groupId={groupId}
to return only vocabs from these group Add query parameteronlyStaged=true
to return only vocabs that are staged Add query parameteronlyActivated=true
to return only vocabs that are already activated (groupId
query parameter can be combined with eitheronlyStaged
oronlyActivated
)Updated GET vocab group GET
/api/group/:groupId/vocabulary
Added query parameter?onlyStaged=true
to only return vocabs of a group that are already activated (for custom learning)Motivation and Context
The activate function was kind of useless, as you could just start a query that throws every inactivated/staged vocabs in a query. You couldn't decide which group you want to add to your daily query. With this PR i want to provide the backend basis to implement group specific vocab activation.
In addition to this this PR will give the basis to implement the upcoming "Custom Learning" functionality (issued here vocascan/vocascan-frontend#126
Screenshots / GIFs (if appropriate):
Checklist
Resolves
vocascan/vocascan-server#93 vocascan/vocascan-frontend#126 vocascan/vocascan-frontend#132