Update Endpoint interface (from design review)

Description

Note: the bulk of the implementation work is done as part of https://openedx.atlassian.net/browse/MA-1017. This story is just to verify that the new implementation follows the approved design and these changes are integration tested with the apps.

No longer use course_structure_api bound naming.

Endpoints

Before

After

api/xblock/v0/xblock/<usage_id>

/xblock/<usage_id>?view=student_view

api/course_structure/v0/courses/<course_id>/blocks

/api/courses/v1/blocks/?course_id=<course_id>&user=username&depth=all&requested_fields=graded,format,student_view_multi_device&student_view_data=video&block_counts=video&nav_depth=3

URL parameters

Before

After

Type Change

block_count

block_counts

same (list of block types)

has_responsive_ui

student_view_multi_device

in requested_fields

block_json

student_view_data

from dict to list of block types

fields

requested_fields

same

navigation_depth

nav_depth

same

n/a

user

string user's user_name

Response Fields

Before

After

block_json

student_view_data

block_url

student_view_url

web_url

lms_web_url

has_responsive_ui

student_view_multi_device

block_count

block_counts

Payload Container

Before

After

blocks+navigation

blocks

Steps to Reproduce

None

Reason for Variance

None

Release Notes

None

Customer Problem Statement

None

Status

Assignee

Unassigned

Reporter

Nimisha Asthagiri

Labels

Customer

None

Partner Manager

None

URL

None

Contributor Name

None

Groups with Read-Only Access

None

Actual Points

None

Sub-Team(s)

None

Reach

None

Impact

None

Open edX Discourse Thread

None

Story Points

1

Epic Link

Components

Priority

Unset
Configure