Skip to content

Commit 904b6c1

Browse files
authored
Merge pull request #37413 from openedx/feanil/fix_docs_build
fix: Fix the docs build.
2 parents 3b6a185 + d0140a2 commit 904b6c1

2 files changed

Lines changed: 136 additions & 3 deletions

File tree

docs/docs_settings.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
INSTALLED_APPS.extend(
3535
[
3636
"cms.djangoapps.contentstore.apps.ContentstoreConfig",
37+
'cms.djangoapps.modulestore_migrator',
3738
"cms.djangoapps.course_creators",
3839
"cms.djangoapps.xblock_config.apps.XBlockConfig",
3940
"lms.djangoapps.lti_provider",

docs/lms-openapi.yaml

Lines changed: 135 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3523,11 +3523,77 @@ paths:
35233523
in: path
35243524
required: true
35253525
type: string
3526+
/dashboard/v0/programs/:
3527+
get:
3528+
operationId: dashboard_v0_programs_list
3529+
description: |-
3530+
For a learner, get list of enrolled programs with progress.
3531+
If an enterprise UUID ias provided, filter out all non-enterprise enrollments for the learner.
3532+
3533+
**Example Request**
3534+
3535+
GET /api/dashboard/v1/programs/{enterprise_uuid}/
3536+
3537+
**Parameters**
3538+
3539+
* `enterprise_uuid`: UUID of an enterprise customer.
3540+
3541+
**Example Response**
3542+
3543+
[
3544+
{
3545+
"uuid": "ff41a5eb-2a73-4933-8e80-a1c66068ed2c",
3546+
"title": "Demonstration Program",
3547+
"type": "MicroMasters",
3548+
"banner_image": {
3549+
"large": {
3550+
"url": "http://example.com/images/foo.large.jpg",
3551+
"width": 1440,
3552+
"height": 480
3553+
},
3554+
"medium": {
3555+
"url": "http://example.com/images/foo.medium.jpg",
3556+
"width": 726,
3557+
"height": 242
3558+
},
3559+
"small": {
3560+
"url": "http://example.com/images/foo.small.jpg",
3561+
"width": 435,
3562+
"height": 145
3563+
},
3564+
"x-small": {
3565+
"url": "http://example.com/images/foo.x-small.jpg",
3566+
"width": 348,
3567+
"height": 116
3568+
}
3569+
},
3570+
"authoring_organizations": [
3571+
{
3572+
"key": "example"
3573+
}
3574+
],
3575+
"progress": {
3576+
"uuid": "ff41a5eb-2a73-4933-8e80-a1c66068ed2c",
3577+
"completed": 0,
3578+
"in_progress": 0,
3579+
"not_started": 2
3580+
}
3581+
}
3582+
]
3583+
parameters: []
3584+
responses:
3585+
'200':
3586+
description: ''
3587+
tags:
3588+
- dashboard
3589+
parameters: []
35263590
/dashboard/v0/programs/{enterprise_uuid}/:
35273591
get:
35283592
operationId: dashboard_v0_programs_read
3529-
summary: For an enterprise learner, get list of enrolled programs with progress.
35303593
description: |-
3594+
For a learner, get list of enrolled programs with progress.
3595+
If an enterprise UUID ias provided, filter out all non-enterprise enrollments for the learner.
3596+
35313597
**Example Request**
35323598
35333599
GET /api/dashboard/v1/programs/{enterprise_uuid}/
@@ -6446,11 +6512,77 @@ paths:
64466512
tags:
64476513
- learner_home
64486514
parameters: []
6515+
/learner_home/v1/programs/:
6516+
get:
6517+
operationId: learner_home_v1_programs_list
6518+
description: |-
6519+
For a learner, get list of enrolled programs with progress.
6520+
If an enterprise UUID ias provided, filter out all non-enterprise enrollments for the learner.
6521+
6522+
**Example Request**
6523+
6524+
GET /api/dashboard/v1/programs/{enterprise_uuid}/
6525+
6526+
**Parameters**
6527+
6528+
* `enterprise_uuid`: UUID of an enterprise customer.
6529+
6530+
**Example Response**
6531+
6532+
[
6533+
{
6534+
"uuid": "ff41a5eb-2a73-4933-8e80-a1c66068ed2c",
6535+
"title": "Demonstration Program",
6536+
"type": "MicroMasters",
6537+
"banner_image": {
6538+
"large": {
6539+
"url": "http://example.com/images/foo.large.jpg",
6540+
"width": 1440,
6541+
"height": 480
6542+
},
6543+
"medium": {
6544+
"url": "http://example.com/images/foo.medium.jpg",
6545+
"width": 726,
6546+
"height": 242
6547+
},
6548+
"small": {
6549+
"url": "http://example.com/images/foo.small.jpg",
6550+
"width": 435,
6551+
"height": 145
6552+
},
6553+
"x-small": {
6554+
"url": "http://example.com/images/foo.x-small.jpg",
6555+
"width": 348,
6556+
"height": 116
6557+
}
6558+
},
6559+
"authoring_organizations": [
6560+
{
6561+
"key": "example"
6562+
}
6563+
],
6564+
"progress": {
6565+
"uuid": "ff41a5eb-2a73-4933-8e80-a1c66068ed2c",
6566+
"completed": 0,
6567+
"in_progress": 0,
6568+
"not_started": 2
6569+
}
6570+
}
6571+
]
6572+
parameters: []
6573+
responses:
6574+
'200':
6575+
description: ''
6576+
tags:
6577+
- learner_home
6578+
parameters: []
64496579
/learner_home/v1/programs/{enterprise_uuid}/:
64506580
get:
64516581
operationId: learner_home_v1_programs_read
6452-
summary: For an enterprise learner, get list of enrolled programs with progress.
64536582
description: |-
6583+
For a learner, get list of enrolled programs with progress.
6584+
If an enterprise UUID ias provided, filter out all non-enterprise enrollments for the learner.
6585+
64546586
**Example Request**
64556587
64566588
GET /api/dashboard/v1/programs/{enterprise_uuid}/
@@ -6912,7 +7044,7 @@ paths:
69127044
django settings. This is a temporary change as a part of the migration of some legacy
69137045
pages to MFEs. This is a temporary compatibility layer which will eventually be deprecated.
69147046
6915-
See [Link to DEPR ticket] for more details. todo: add link
7047+
See [DEPR ticket](https://github.com/openedx/edx-platform/issues/37210) for more details.
69167048
69177049
The compatability means that settings from the legacy locations will continue to work but
69187050
the settings listed below in the `_get_legacy_config` function should be added to the MFE

0 commit comments

Comments
 (0)