Repository navigation
refactor: read the course outline from authoring v2 (FC-0118) - #3373
taimoor-ahmed-1 wants to merge 1 commit into
Conversation
The course outline page read GET /api/contentstore/v1/course_index/{course_id},
which openedx-platform#39229 supersedes with
GET /api/authoring/v2/courses/{course_key}/outline/.
getCourseOutlineIndex now requests that address with view=full, which
returns the v1 payload under the same field names. The default view is a
thin tree of block names and does not carry the block settings or page
data the outline and the competency-management course browser read.
Components, hooks and selectors are unchanged.
The full view drops initial_user_clipboard, which nothing read; the
clipboard comes from the content-staging API. It is removed from the
CourseOutline type and the test outline builder.
|
Thanks for the pull request, @taimoor-ahmed-1! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. 🔘 Update the status of your PRYour PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate. Where can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #3373 +/- ##
==========================================
+ Coverage 96.36% 96.38% +0.02%
==========================================
Files 1467 1472 +5
Lines 36182 36465 +283
Branches 8692 8813 +121
==========================================
+ Hits 34867 35148 +281
- Misses 1272 1275 +3
+ Partials 43 42 -1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Description
Part of #3361 (FC-0118 Phase 3, parent openedx/openedx-platform#39349).
Draft until openedx/openedx-platform#39229 merges: it adds the endpoint this PR calls. The old address stays live until it is removed through the DEPR process (openedx/openedx-platform#39128).
GET /api/contentstore/v1/course_index/{course_id}→GET /api/authoring/v2/courses/{course_key}/outline/?view=full.The default v2 view is a thin tree of block names.
view=fullreturns the v1 payload under the v1 field names, built by the same server code, so no reshaping is needed. The only top-level field it drops isinitial_user_clipboard, which the MFE never read; it is removed from theCourseOutlinetype. The competency-management screens use the same query, so they move too.User roles impacted: Course Author (course outline; competency management). No visible change expected.
Supporting information
Testing instructions
npm test -- src/course-outline src/taxonomy/competency-managementOther information
Best Practices Checklist
.ts,.tsx).propTypesanddefaultPropsin any new or modified code.src/testUtils.tsx(specificallyinitializeMocks)apiHooks.tsin this repo for examples.messages.tsfiles have adescriptionfor translators to use. (None added.)../in import paths. To import from parent folders, use@src, e.g.import { initializeMocks } from '@src/testUtils';instead offrom '../../../../testUtils'