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

Python API to get tag counts, ignore deleted/disabled ObjectTags by default [FC-0036] #115

Merged
merged 3 commits into from
Nov 13, 2023

Conversation

bradenmacdonald
Copy link
Contributor

This PR:

  1. Makes the get_object_tag_counts API available via python as well as REST. Previously it was REST-only.
  2. Makes the get_object_tags and get_object_tag_counts APIs ignore tags from deleted or disabled taxonomies by default. Anything else would be confusing for users. Keep in mind, we do preserve the underlying ObjectTag data; we just don't want to display it.

This is for openedx/modular-learning#118 part 1b.

Private ref: FAL-3564.

@bradenmacdonald bradenmacdonald added the FC Relates to an Axim Funded Contribution project label Nov 10, 2023
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 10, 2023
@openedx-webhooks
Copy link

Thanks for the pull request, @bradenmacdonald! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

1 similar comment
@openedx-webhooks
Copy link

Thanks for the pull request, @bradenmacdonald! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@bradenmacdonald
Copy link
Contributor Author

FYI @ChrisChV since you mentioned the issue with deleted/disabled object tags being included in the APIs - I fixed it here.

Copy link
Contributor

@pomegranited pomegranited left a comment

Choose a reason for hiding this comment

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

👍 Looks fine, thanks @bradenmacdonald !

But I think this needs a version bump?

  • I tested this using django runserver, hit the modified APIs
  • I read through the code
  • I checked for accessibility issues N/A
  • Includes documentation
  • User-facing strings are extracted for translation N/A

@bradenmacdonald bradenmacdonald merged commit 9c19cf3 into main Nov 13, 2023
11 checks passed
@bradenmacdonald bradenmacdonald deleted the braden/python-counts-api branch November 13, 2023 20:34
@openedx-webhooks
Copy link

@bradenmacdonald 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants