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

Expose roster information on the user metrics endpoint #6871

Merged
merged 3 commits into from
Dec 10, 2024

Conversation

marcospri
Copy link
Member

@marcospri marcospri commented Nov 26, 2024

Proposed changes to the API structure to accommodate roster meta-information on the metrics endpoint.

That endpoint currently return a list of students, update it to return an APIRoster object which does contain the same APIStudent entries augmented with:

active: bool, for each student.
last_udpaetd: datetime, for the whole roster.

Once we agree on a API format we could:

  • In one PR change the API in the BE and the FE to expect the new structure
  • In successive BE PRs, start sending the right data in the new fields.
  • FE changes to present the new information.

More context:

@marcospri marcospri force-pushed the roster-dashboard-api branch from 9af7c04 to 6e8b16e Compare November 27, 2024 08:50
@marcospri marcospri requested a review from acelaya November 27, 2024 08:58
Copy link
Contributor

@acelaya acelaya 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 to me, except that I think we should not make the API contract more complex with more nested levels.

It will also be easier to support both assignments with reoster and without roster, by making the FE know the only difference is that the active prop may not be there at all.

lms/js_config_types.py Outdated Show resolved Hide resolved
@marcospri marcospri force-pushed the roster-dashboard-api branch from 6e8b16e to c6bf186 Compare November 27, 2024 14:10
@marcospri marcospri requested a review from acelaya November 27, 2024 14:27
Copy link
Contributor

@acelaya acelaya left a comment

Choose a reason for hiding this comment

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

This looks good to me

@acelaya
Copy link
Contributor

acelaya commented Dec 10, 2024

I have merged #6898, #6899 and #6905 into this PR, so that both BE and FE logic can be tested and merged together.

@marcospri marcospri force-pushed the roster-dashboard-api branch from 48e1891 to 961499c Compare December 10, 2024 09:33
@marcospri marcospri merged commit 385d981 into main Dec 10, 2024
9 checks passed
@marcospri marcospri deleted the roster-dashboard-api branch December 10, 2024 09:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants