feat: add mfe config api

[MaferMazu]

Description

This PR adds MFE Config API. This is part of the work that is being done to obtain the MFE Runtime Configurations and that has been discussed in the BTR WG.

• Discussion
• MFE Runtime configuration - eduNEXT

Testing instructions

1. Use this edx-platform version in you tutor installation
2. Enable the API
   2.1. In the tutor_root (to know your tutor_root: tutor config printroot ), in the env > apps > openedx > config > lms.env.json file add "ENABLE_MFE_CONFIG_API": true,
3. Run the tutor in dev mode tutor dev start
4. You can make request to the API (endpoint /api/v1/mfe_config)
   4.1. Example: <your_domain>/api/v1/mfe_config
   4.2 Example: <your_domain>/api/v1/mfe_config?mfe=mymfe

This API takes the information found in MFE_CONFIG and MFE_CONFIG_MYMFE key in site configuration ( admin > site configuration > your domain); and if you want to add information you just have to add something like this:

"MFE_CONFIG" : {
    "LOGO_URL": "https://example.com/logo.png",
},
"MFE_CONFIG_MYMFE" : {
    "LOGO_URL": "https://example.com/mymfe-logo.png",
}

[openedx-webhooks]

Thanks for the pull request, @MaferMazu! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

• supporting documentation
• Open edX discussion forum threads
• timeline information ("this must be merged by XX date", and why that is)
• partner information ("this is a course on edx.org")
• any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

[natabene]

@MaferMazu Thank you for your contribution. Please let me know once it is ready.

[arbrandes]

Thanks for this, @MaferMazu! It's on my queue to review ASAP.

[MaferMazu]

Thanks @arbrandes
By the way, I don't know if openedx/core/djangoapps is the best place to add the mfe api or if it should be in lms/djangoapps, what do you think?

[mariajgrimaldi]

I'm not sure if this is the final location for this application, either way, please consider this ADR for new applications that's underway.

[MaferMazu]

Thanks a lot for that info @mariajgrimaldi I am going to take a look and make a decision about the location for this app.

[felipemontoya]

The API looks very lightweight and I love that. I left a note inline, but once that is fixed (or discussed at least) I would approve.

[felipemontoya]

We could remove the draft label though.

[MaferMazu]

Thanks @mariajgrimaldi for mentioning the ADR for new applications, however, this PR allows configuration in runtime with mfes and we would like to solve this problem in the community, for this reason, I still want to include this little API.

I am also super attentive to any comments.

[edx-pipeline-bot]

EdX Release Notice: This PR has been deployed to the staging environment in preparation for a release to production.

[arbrandes]

@MaferMazu, congrats on the merge, and thank you for your patience!

[edx-pipeline-bot]

EdX Release Notice: This PR has been deployed to the production environment.

[kdmccormick]

Thanks for all your work on this! It is going to help us provide a reasonably-sized, pre-built Tutor MFE image, which is something that folks have wanted for a long time.

If it's not too late, I have a couple suggested changes:

• Document the behavior of the API response in the docstring.
  • Without the query parameter, only common config is returned; with the query paramter, MFE's specific config is merged with common config. This design is great! The API's docstring doesn't explain it, though--I had to read the code and the ADR to figure it out.
• Change the base URL from /api/v1/mfe_config to /api/mfe_config/v1.
  • Why? Because the version number (v1) should come after the thing it is versioning. In the current construction, it is implying that mfe_config is part of the first version of the entire LMS's API. In reality, it is just the first version of the mfe_config API.

[kdmccormick]

Hey @MaferMazu and @felipemontoya, I've proposed some changes (including the ones I mentioned above) to the API: #30830

Would either of you mind taking a look?