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 endpoint for downloading the taxonomy templates [FC-0036] #33464

Merged
merged 1 commit into from
Oct 11, 2023

Conversation

pomegranited
Copy link
Contributor

@pomegranited pomegranited commented Oct 11, 2023

Description

This PR adds a Studio endpoint for downloading the CSV and JSON templates added to oel_tagging by openedx/openedx-learning#89

Will be used by Taxonomy Admins/Course Authors once the Taxonomy Admin UI is built.

Supporting information

Closes openedx/modular-learning#137
Private-ref: FAL-3520

Testing instructions

Using this branch in your devstack's cms-shell:

  1. Update requirements: paver install_prereqs
  2. Update migrations: ./manage.py lms migrate
  3. Download the template files:
    http://localhost:18010/api/content_tagging/v1/taxonomies/import/template.csv
    http://localhost:18010/api/content_tagging/v1/taxonomies/import/template.json
  4. Check that the files download as expected.

Deadline

None

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Oct 11, 2023
@openedx-webhooks
Copy link

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

Copy link
Contributor

@rpenido rpenido left a comment

Choose a reason for hiding this comment

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

@pomegranited Good work here! 👍

  • I read through the code
  • I tested this: I read through the tests to make sure it covers the cases. I ran the migrations and test.

Nit: There is a typo in the Testing Instructions. The second link should be: http://localhost:18010/api/content_tagging/v1/taxonomies/import/template.csv

We have a failed test, but it seems that it is related to the runner:

The self-hosted runner: edx-platform-openedx-ci-runner-deployment-7xdl7-n5s2j lost communication with the server. Verify the machine is running and has a healthy network connection. Anything in your workflow that terminates the runner process, starves it for CPU/Memory, or blocks its network access can cause this error.

It would be good to trigger the CD/CI again (pushing an empty commit or updating the branch).

@bradenmacdonald bradenmacdonald merged commit ba5546e into openedx:master Oct 11, 2023
62 checks passed
@bradenmacdonald bradenmacdonald deleted the jill/taxonomy-templates branch October 11, 2023 17:59
@openedx-webhooks
Copy link

@pomegranited 🎉 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
Copy link
Contributor

@rpenido There's no need to push again - the GitHub UI has a button to re-try the failed tests.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

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] Create Taxonomy Templates
5 participants