Skip to content

[SE-3329] Expose banner image url in course API - #260

Merged
gabor-boros merged 1 commit into
opencraft-release/juniper.3from
gabor/expose-banner-image-juniper3
Sep 25, 2020
Merged

[SE-3329] Expose banner image url in course API#260
gabor-boros merged 1 commit into
opencraft-release/juniper.3from
gabor/expose-banner-image-juniper3

Conversation

@gabor-boros

@gabor-boros gabor-boros commented Sep 25, 2020

Copy link
Copy Markdown

This PR extends the course overview and detail APIs to include (both relative and absolute) banner image url, which allows content publishers to specify a banner image and then reuse that from a custom UI/integration.

Dependencies: None

Upstream PR: https://github.com/edx/edx-platform/pull/25045

Screenshots:

Course which has a banner image
Screenshot 2020-09-22 at 14 50 14

Course which has no banner image
Screenshot 2020-09-22 at 14 56 01

Sandbox URL: https://studio.pr25045.stage.opencraft.hosting/ (Credentials are the usual defaults)

Merge deadline: Preferably 29th of September

Testing instructions:

  1. Open edX Studio from Content -> Files & Uploads, then copy the file name
  2. Paste the file name into Course Banner Image field into Settings -> Advanced Settings page
  3. Open <URL>/api/courses/v1/courses/ to check all the courses, where URL is the sandbox LMS URL
  4. Open <URL>/api/courses/v1/courses/<course_id> to see all the courses, where URL is the sandbox LMS URL and course_id is the course id

Author notes and concerns:

  1. The _AbsolutMediaSerializer is using a private attribute from AbsoluteURLField, but I found no other way to avoid code duplication and have the same absolute url conversion functionality, since AbsoluteURLField requires the request object
    Currently looking for ways to fix it.

Reviewers

Settings

EDXAPP_FEATURES:
  ENABLE_COMBINED_LOGIN_REGISTRATION: true

@gabor-boros
gabor-boros requested a review from toxinu September 25, 2020 06:47
@gabor-boros gabor-boros self-assigned this Sep 25, 2020

@toxinu toxinu left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I have already reviewed, tested and approved the upstream PR. Looks good to merge 👍🏻

@gabor-boros
gabor-boros merged commit ec4b506 into opencraft-release/juniper.3 Sep 25, 2020
@gabor-boros
gabor-boros deleted the gabor/expose-banner-image-juniper3 branch September 25, 2020 07:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants