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: Implement ObjectTag retrieve REST API #68

Conversation

yusuf-musleh
Copy link
Member

@yusuf-musleh yusuf-musleh commented Aug 1, 2023

Description

This PR implements the tagging REST API for retrieving object tags.

Adding/updating object tags will be handled in a subsequent PR.

Supporting Information

Testing instructions

  • Ensure that the tests cover the expected behavior of the view as described in the related issue.

Private-ref: FAL-3452

@yusuf-musleh yusuf-musleh force-pushed the yusuf-musleh/implement-tagging-rest-api-retrieve-object-tags branch 4 times, most recently from 8008c1e to 4c89229 Compare August 3, 2023 09:47
@yusuf-musleh yusuf-musleh changed the title [WIP] feat: Initial implementation of ObjectTagView + tests feat: Implement ObjectTag retrieve REST API Aug 3, 2023
@yusuf-musleh yusuf-musleh marked this pull request as ready for review August 3, 2023 09:53
@openedx-webhooks
Copy link

openedx-webhooks commented Aug 3, 2023

Thanks for the pull request, @yusuf-musleh! 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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Aug 3, 2023
@mphilbrick211 mphilbrick211 added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Aug 7, 2023
@yusuf-musleh yusuf-musleh force-pushed the yusuf-musleh/implement-tagging-rest-api-retrieve-object-tags branch 2 times, most recently from 2dbcb33 to 41e7034 Compare August 14, 2023 15:46
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.

Thank you @yusuf-musleh , this is looking good.

I've requested one small change below, but once that's done it's good to go into CC review.
@bradenmacdonald could you have a look when you get a chance?

👍

  • I tested this by running the edx-platform code from feat: Add retrieve object_tags REST API open-craft/edx-platform#577 with this branch installed. Created some object_tags using the shell, and checked that the REST API returned the expected data when queried.
  • I read through the code
  • I checked for accessibility issues N/A
  • Includes documentation for the added REST API

openedx_tagging/core/tagging/api.py Show resolved Hide resolved
@mphilbrick211 mphilbrick211 removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Aug 15, 2023
Copy link
Contributor

@bradenmacdonald bradenmacdonald 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. I just had one request about adding a test case, but you can also let me know if it's already covered somewhere else.

openedx_tagging/core/tagging/rest_api/v1/views.py Outdated Show resolved Hide resolved
@yusuf-musleh yusuf-musleh force-pushed the yusuf-musleh/implement-tagging-rest-api-retrieve-object-tags branch from 41e7034 to f848861 Compare August 16, 2023 08:05
@yusuf-musleh yusuf-musleh force-pushed the yusuf-musleh/implement-tagging-rest-api-retrieve-object-tags branch 2 times, most recently from 83741de to 1013db9 Compare August 16, 2023 08:33
@pomegranited
Copy link
Contributor

@yusuf-musleh Could you also please bump the patch version ? see openedx_learning/init.py

Retrieve ObjectTags for given Object IDs, and optionally filter by
taxonomy.
@yusuf-musleh yusuf-musleh force-pushed the yusuf-musleh/implement-tagging-rest-api-retrieve-object-tags branch from 1013db9 to 0e6f12f Compare August 17, 2023 10:17
@yusuf-musleh
Copy link
Member Author

@yusuf-musleh Could you also please bump the patch version ? see openedx_learning/init.py

Yup! Just updated it.

@pomegranited pomegranited merged commit 593d63c into openedx:main Aug 18, 2023
@openedx-webhooks
Copy link

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

@bradenmacdonald bradenmacdonald deleted the yusuf-musleh/implement-tagging-rest-api-retrieve-object-tags branch September 1, 2023 18:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

[Tagging] Implement tagging REST API: Retrieve object tags
5 participants