fix: Use specific sort order for Instructor Dashboard roles.#38478
fix: Use specific sort order for Instructor Dashboard roles.#38478wgu-taylor-payne merged 2 commits intoopenedx:masterfrom
Conversation
|
Thanks for the pull request, @brianjbuck-wgu! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
|
Tested it on UI and works as expected 👍 |
wgu-taylor-payne
left a comment
There was a problem hiding this comment.
Clean implementation — sort-key dict with fallback for unknown roles is the right pattern.
One nit: the CourseTeamRolesView docstring example (~line 3084 in api_v2.py) still shows roles in alphabetical order. Should be updated to reflect the new sort order:
{"role": "staff", "display_name": "Staff"},
{"role": "limited_staff", "display_name": "Limited Staff"},
{"role": "instructor", "display_name": "Admin"},
{"role": "beta", "display_name": "Beta Tester"},
{"role": "data_researcher", "display_name": "Data Researcher"}Review assisted by Kiro
Description
The
CourseTeamRolesViewendpoint returns roles in alphabetical order, which doesn't match the desired display order in the Instructor Dashboard. This changes the endpoint to return roles in a specific order:Supporting information
frontend-app-instructor-dashboard#102 (comment)
Testing instructions
Deadline
Verawood