Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Support content renderable_only option in tasks API #11519

Merged

Conversation

dbnicholson
Copy link
Contributor

This is the last non-backend specific option to allow the tasks API to have the same interface as the CLI.

Summary

I wanted to make an API request to import content with renderable_only=False (equivalent to --include-unrenderable-content), but that's not in the API.

References

Similar to #10229.

Reviewer guidance

Create a homedir and provision the facility with a superuser. Then run the server with --settings kolibri.deployment.default.settings.dev so it accepts HTTP Basic authentication. Then you can trigger a content import like:

curl -u "$user:$password" -H 'Content-Type: application/json' -d '{"type": "kolibri.core.content.tasks.remotecontentimport", "channel_id": "$some_channel_id", "channel_name": "something", "renderable_only": false}' http://127.0.0.1:8080/api/tasks/tasks/

Testing checklist

  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Critical and brittle code paths are covered by unit tests

PR process

  • PR has the correct target branch and milestone
  • PR has 'needs review' or 'work-in-progress' label
  • If PR is ready for review, a reviewer has been added. (Don't use 'Assignees')
  • If this is an important user-facing change, PR or related issue has a 'changelog' label
  • If this includes an internal dependency change, a link to the diff is provided

Reviewer checklist

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

This is the last non-backend specific option to allow the tasks API to
have the same interface as the CLI.
@github-actions github-actions bot added DEV: backend Python, databases, networking, filesystem... SIZE: very small labels Nov 10, 2023
@MisRob MisRob requested review from bjester and rtibbles November 30, 2023 08:19
Copy link
Member

@bjester bjester 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 to me. @rtibbles ?

Copy link
Member

@rtibbles rtibbles left a comment

Choose a reason for hiding this comment

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

Seems fine to me - although this flag has always been of rather limited use!

@rtibbles rtibbles merged commit 24b32d4 into learningequality:release-v0.16.x Dec 5, 2023
@dbnicholson dbnicholson deleted the renderable-only-api branch December 7, 2023 21:14
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
DEV: backend Python, databases, networking, filesystem... SIZE: very small
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants