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

[Tagging] Import/export tags API methods #64

Closed
ChrisChV opened this issue Jun 14, 2023 · 4 comments · Fixed by openedx/openedx-learning#64
Closed

[Tagging] Import/export tags API methods #64

ChrisChV opened this issue Jun 14, 2023 · 4 comments · Fixed by openedx/openedx-learning#64

Comments

@ChrisChV
Copy link

ChrisChV commented Jun 14, 2023

Full description

Implement the import_tags and export_tags methods. Both functions should happen in a background task. Implement an API to see the status of each import. Only one import per taxonomy is allowed at a time.

Update the Tag model and get_tags to meet the following requirement: "When importing taxonomies, the API needs to accept tags that may not be part of the taxonomy now (because they're from an older or newer version of the taxonomy), but not to display them to the user unless the taxonomy is later updated to include those tags."

You need to continue the conversation with Jenna to know the format.

Completion criteria

  • PR against openedx-learning implementing import_tags and export_tags
  • The functions must meet the requirements described on the discovery doc
  • Automated testing must cover common paths in behavioral specification.
@ChrisChV
Copy link
Author

ChrisChV commented Aug 2, 2023

"When importing taxonomies, the API needs to accept tags that may not be part of the taxonomy now (because they're from an older or newer version of the taxonomy), but not to display them to the user unless the taxonomy is later updated to include those tags."

@pomegranited Since you have checked the designs of this stage in more detail, do you think this part of the original discovery requirements is necessary for the MVP?

@pomegranited
Copy link

@ChrisChV

"When importing taxonomies, the API needs to accept tags that may not be part of the taxonomy now.."

I don't even understand what that is saying.. if we're importing taxonomies, then of course there may be new tags that aren't part of it yet?

So I'd say: no, you do not have to worry about what to display to the user or not. You can just import the given tags, creating any new ones and deleting any missing ones, and the new tags list is what gets shown to the user. As pert of a separate task, we can tweak the "resync" function to handle any side effects.

@ChrisChV
Copy link
Author

ChrisChV commented Aug 3, 2023

@pomegranited

I don't even understand what that is saying.. if we're importing taxonomies, then of course there may be new tags that aren't part of it yet?

What I understood was that there may be Tags in the database that are not enabled (perhaps enable=false) and that in the import you can add disabled Tags and enable others.

So I'd say: no, you do not have to worry about what to display to the user or not.

I also think that for now it is not necessary for the MVP

@pomegranited
Copy link

@ChrisChV this is the first I've heard of enabled/disabled Tags -- we only had Taxonomies enabled/disabled. So yep, feel free to keep it simple for MVP.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
3 participants