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

feat: adds sorting support to enterprise-customer-members endpoint #2311

Merged
merged 3 commits into from
Jan 13, 2025

Conversation

katrinan029
Copy link
Contributor

@katrinan029 katrinan029 commented Jan 10, 2025

Adds sorting support to the enterprise-customer-members endpoint to allow a user to sort by a member's joined_org date and member's name.

https://2u-internal.atlassian.net/browse/ENT-9861

Testing instructions:

  1. add users to an enterprise via the Manage learners page: http://localhost:18000/admin/enterprise/enterprisecustomer/7dbf461e-8d3d-4a4a-9b20-9c9121f04806/manage_learners
  2. go to the enterprise-customer-members endpoint and verify that you can sort the results by joined_org and name via the following parameters:
    -sort_by=name: http://localhost:18000/enterprise/api/v1/enterprise-customer-members/7dbf461e-8d3d-4a4a-9b20-9c9121f04806?sort_by=name
    Screenshot 2025-01-10 at 10 46 38 AM

Merge checklist:

  • Any new requirements are in the right place (do not manually modify the requirements/*.txt files)
    • base.in if needed in production but edx-platform doesn't install it
    • test-master.in if edx-platform pins it, with a matching version
    • make upgrade && make requirements have been run to regenerate requirements
  • make static has been run to update webpack bundling if any static content was updated
  • ./manage.py makemigrations has been run
    • Checkout the Database Migration Confluence page for helpful tips on creating migrations.
    • Note: This must be run if you modified any models.
      • It may or may not make a migration depending on exactly what you modified, but it should still be run.
    • This should be run from either a venv with all the lms/edx-enterprise requirements installed or if you checked out edx-enterprise into the src directory used by lms, you can run this command through an lms shell.
      • It would be ./manage.py lms makemigrations in the shell.
  • Version bumped
  • Changelog record added
  • Translations updated (see docs/internationalization.rst but also this isn't blocking for merge atm)

Post merge:

  • Tag pushed and a new version released
    • Note: Assets will be added automatically. You just need to provide a tag (should match your version number) and title and description.
  • After versioned build finishes in GitHub Actions, verify version has been pushed to PyPI
    • Each step in the release build has a condition flag that checks if the rest of the steps are done and if so will deploy to PyPi.
      (so basically once your build finishes, after maybe a minute you should see the new version in PyPi automatically (on refresh))
  • PR created in edx-platform to upgrade dependencies (including edx-enterprise)
    • Trigger the 'Upgrade one Python dependency' action against master in edx-platform with new version number to generate version bump PR
    • This must be done after the version is visible in PyPi as make upgrade in edx-platform will look for the latest version in PyPi.
    • Note: the edx-enterprise constraint in edx-platform must also be bumped to the latest version in PyPi.

@katrinan029 katrinan029 requested a review from a team January 10, 2025 21:50
@katrinan029 katrinan029 merged commit 23d0122 into master Jan 13, 2025
8 of 10 checks passed
@katrinan029 katrinan029 deleted the knguyen2/ent-9861 branch January 13, 2025 20:10
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