edx-platform

Files

Deborah Kaplan ce8d3211f9 chore: improving programs rest API docs, type hints (#36438 )

* chore:  improving programs rest API docs, type hints

reformatting the docstrings  so they appear correctly in the  openAPI
docs.
* moving them into the `GET`
* some cleanup and simplification of language
* removing real data that refers to specific hosts

regenerated the open API documentation.

also adding type hints to the API and telling `mypy`  to check this
file.  This was primarily because these models are confusing enough in
order to verify that the documentation was correct I had to do a lot of
jumping through the code.

FIXES: APER-3950

2025-03-25 09:39:25 -04:00

docs/decisions

feat: removing visible_date-to-creds updates per-cert (#35113 )

2024-07-17 08:43:12 -04:00

management

refactor!: Remove backpopulate_program_credentials in favor of using

2021-05-05 12:22:38 -04:00

migrations

chore: adding migrations related with django-history. (#32935 )

2023-08-08 16:04:06 +05:00

rest_api

chore: improving programs rest API docs, type hints (#36438 )

2025-03-25 09:39:25 -04:00

tests

refactor: remove PII from log messages in programs tasks (#35623 )

2024-10-15 08:33:36 -04:00

__init__.py

fix: Don't set default_app_config.

2023-09-01 14:41:34 -04:00

admin.py

refactor: Moved ProgramDiscussion/Live Configuration Models to program's app (#29871 )

2022-02-09 15:43:22 +05:00

api.py

Pylint amnesty in openedx plugin_api, profile_images and programs apps (#26377 )

2021-02-04 17:10:38 +05:00

apps.py

refactor: pyupgrade in profile_images, programs, safe_sessions (#26953 )

2021-03-22 17:51:13 +05:00

forms.py

refactor: Moved ProgramDiscussion/Live Configuration Models to program's app (#29871 )

2022-02-09 15:43:22 +05:00

models.py

chore: Add missing PII annotations, update safelist

2024-11-05 12:58:36 -05:00

README.rst

chore: move the program dashboard APIs (#36420 )

2025-03-24 12:06:52 -04:00

signals.py

feat: removing visible_date-to-creds updates per-cert (#35113 )

2024-07-17 08:43:12 -04:00

tasks.py

refactor: remove PII from log messages in programs tasks (#35623 )

2024-10-15 08:33:36 -04:00

utils.py

chore: improving programs rest API docs, type hints (#36438 )

2025-03-25 09:39:25 -04:00

README.rst

Status: Maintenance

Responsibilities
================
The Programs app is responsible for:

* Communicating with the `credentials service`_ (along with the `credentials app`_).
* Program discussion forum and program live configuration.
* The REST API used to render the program dashboard.  Legacy routes for this API, left over
  from the deprecated remnants of the legacy learner dashboard, exist alongside future-proofed
  routes which will work when the deprecated, legacy Program Dashboard is replaced with functionality
  in the Learner Dashboard MFE.

See Also
========

* `course_discovery_`: The system of record for the definition of a program.
* `credentials service_`: The system of record for a learner's Program Certificates and Program Records.
* `learner_record_`: The MFE displaying Program Records to learners.
* `legacy learner_dashboard_`: The legacy front-end for the program dashboard.

.. _course_discovery: https://github.com/openedx/course-discovery/

.. _credentials app: https://github.com/openedx/edx-platform/tree/master/openedx/core/djangoapps/credentials

.. _credentials service: https://github.com/openedx/credentials

.. _legacy learner_dashboard: https://github.com/openedx/edx-platform/tree/master/lms/djangoapps/learner_dashboard

.. _learner_record: https://github.com/openedx/frontend-app-learner-record