apluslms / a-plus

A+ frontend portal - A+ LMS documentation:

https://apluslms.github.io/

Other

64 stars 72 forks source link

Add the course image to the API #1353

Closed jaakkonakaza closed 2 months ago

jaakkonakaza commented 3 months ago

Description

What?

Adds the course image to the API.

Why?

We are planning to show the course image in the IntelliJ plugin, so I made it easier to access.

How?

Adds the image field to the CourseSerializer.

Testing

Remember to add or update unit tests for new features and changes.

How to test your changes in A-plus
How to test accessibility

What type of test did you run?

[ ] Accessibility test using the WAVE extension.
[ ] Django unit tests.
[ ] Selenium tests.
[ ] Other test. (Add a description below)
[x] Manual testing.
Tested the API with no course image, which returns "image": null
Tested a course with an image, which returned "image": "http://localhost:8000/media/public/course_instance_1/O12024Thumbnail.png"

Did you test the changes in

[x] Chrome
[ ] Firefox
[ ] This pull request cannot be tested in the browser.

Think of what is affected by these changes and could become broken

Translation

[ ] Did you modify or add new strings in the user interface? (Read about how to create translation)

Programming style

[x] Did you follow our style guides?
[ ] Did you use Python type hinting in all functions that you added or edited? (type hints for function parameters and return values)

Have you updated the README or other relevant documentation?

[ ] documents inside the doc directory.
[ ] README.md.
[ ] Aplus Manual.
[ ] Other documentation (mention below which documentation).

Is it Done?

[ ] Reviewer has finished the code review
[ ] After the review, the developer has made changes accordingly
[ ] Customer/Teacher has accepted the implementation of the feature

Clean up your git commit history before submitting the pull request!