diff --git a/openedx_events/learning/signals.py b/openedx_events/learning/signals.py index 0f3a74df..e38e6345 100644 --- a/openedx_events/learning/signals.py +++ b/openedx_events/learning/signals.py @@ -32,8 +32,11 @@ # .. event_type: org.openedx.learning.student.registration.completed.v1 # .. event_name: STUDENT_REGISTRATION_COMPLETED +# .. event_key_field: user.pii.username # .. event_description: emitted when the user registration process in the LMS is completed. # .. event_data: UserData +# .. event_trigger_repository: openedx/edx-platform +# .. event_trigger: openedx/core/djangoapps/user_authn/views/register.py STUDENT_REGISTRATION_COMPLETED = OpenEdxPublicSignal( event_type="org.openedx.learning.student.registration.completed.v1", data={ @@ -47,6 +50,8 @@ # .. event_key_field: user.pii.username # .. event_description: emitted when the user's login process in the LMS is completed. # .. event_data: UserData +# .. event_trigger_repository: openedx/edx-platform +# .. event_trigger: openedx/core/djangoapps/user_authn/views/login.py SESSION_LOGIN_COMPLETED = OpenEdxPublicSignal( event_type="org.openedx.learning.auth.session.login.completed.v1", data={ @@ -57,8 +62,11 @@ # .. event_type: org.openedx.learning.course.enrollment.created.v1 # .. event_name: COURSE_ENROLLMENT_CREATED +# .. event_key_field: enrollment.course.course_key # .. event_description: emitted when the user's enrollment process is completed. # .. event_data: CourseEnrollmentData +# .. event_trigger_repository: openedx/edx-platform +# .. event_trigger: common/djangoapps/student/models/course_enrollment.py COURSE_ENROLLMENT_CREATED = OpenEdxPublicSignal( event_type="org.openedx.learning.course.enrollment.created.v1", data={ @@ -69,8 +77,11 @@ # .. event_type: org.openedx.learning.course.enrollment.changed.v1 # .. event_name: COURSE_ENROLLMENT_CHANGED +# .. event_key_field: enrollment.course.course_key # .. event_description: emitted when the user's enrollment update process is completed. # .. event_data: CourseEnrollmentData +# .. event_trigger_repository: openedx/edx-platform +# .. event_trigger: common/djangoapps/student/models/course_enrollment.py COURSE_ENROLLMENT_CHANGED = OpenEdxPublicSignal( event_type="org.openedx.learning.course.enrollment.changed.v1", data={ @@ -84,6 +95,8 @@ # .. event_key_field: enrollment.course.course_key # .. event_description: emitted when the user's unenrollment process is completed. # .. event_data: CourseEnrollmentData +# .. event_trigger_repository: openedx/edx-platform +# .. event_trigger: common/djangoapps/student/models/course_enrollment.py COURSE_UNENROLLMENT_COMPLETED = OpenEdxPublicSignal( event_type="org.openedx.learning.course.unenrollment.completed.v1", data={ @@ -97,6 +110,8 @@ # .. event_key_field: certificate.course.course_key # .. event_description: emitted when the user's certificate creation process is completed. # .. event_data: CertificateData +# .. event_trigger_repository: openedx/edx-platform +# .. event_trigger: lms/djangoapps/certificates/models.py CERTIFICATE_CREATED = OpenEdxPublicSignal( event_type="org.openedx.learning.certificate.created.v1", data={ @@ -109,6 +124,8 @@ # .. event_key_field: program_certificate.program.uuid # .. event_description: Emit when a program certificate is awarded to a learner # .. event_data: ProgramCertificateData +# .. event_trigger_repository: openedx/credentials +# .. event_trigger: credentials/apps/credentials/issuers.py PROGRAM_CERTIFICATE_AWARDED = OpenEdxPublicSignal( event_type="org.openedx.learning.program.certificate.awarded.v1", data={ @@ -120,6 +137,8 @@ # .. event_name: CERTIFICATE_CHANGED # .. event_description: emitted when the user's certificate update process is completed. # .. event_data: CertificateData +# .. event_trigger_repository: openedx/edx-platform +# .. event_trigger: lms/djangoapps/certificates/models.py CERTIFICATE_CHANGED = OpenEdxPublicSignal( event_type="org.openedx.learning.certificate.changed.v1", data={ @@ -133,6 +152,8 @@ # .. event_key_field: certificate.course.course_key # .. event_description: emitted when the user's certificate annulation process is completed. # .. event_data: CertificateData +# .. event_trigger_repository: openedx/edx-platform +# .. event_trigger: lms/djangoapps/certificates/models.py CERTIFICATE_REVOKED = OpenEdxPublicSignal( event_type="org.openedx.learning.certificate.revoked.v1", data={ @@ -145,6 +166,8 @@ # .. event_key_field: program_certificate.program.uuid # .. event_description: Emit when a program certificate is revoked from a learner # .. event_data: ProgramCertificateData +# .. event_trigger_repository: openedx/credentials +# .. event_trigger: credentials/apps/credentials/issuers.py PROGRAM_CERTIFICATE_REVOKED = OpenEdxPublicSignal( event_type="org.openedx.learning.program.certificate.revoked.v1", data={ @@ -156,6 +179,8 @@ # .. event_name: COHORT_MEMBERSHIP_CHANGED # .. event_description: emitted when the user's cohort update is completed. # .. event_data: CohortData +# .. event_trigger_repository: openedx/edx-platform +# .. event_trigger: openedx/core/djangoapps/course_groups/models.py COHORT_MEMBERSHIP_CHANGED = OpenEdxPublicSignal( event_type="org.openedx.learning.cohort_membership.changed.v1", data={ @@ -169,6 +194,8 @@ # .. event_description: emitted when the configuration for a course's discussions changes in the course # .. event_warning: This event is currently incompatible with the event bus, list/dict cannot be serialized yet # .. event_data: CourseDiscussionConfigurationData +# .. event_trigger_repository: openedx/edx-platform +# .. event_trigger: openedx/core/djangoapps/discussions/tasks.py COURSE_DISCUSSIONS_CHANGED = OpenEdxPublicSignal( event_type="org.openedx.learning.discussions.configuration.changed.v1", data={ @@ -180,6 +207,8 @@ # .. event_name: PERSISTENT_GRADE_SUMMARY_CHANGED # .. event_description: emitted when a grade changes in the course # .. event_data: PersistentCourseGradeData +# .. event_trigger_repository: openedx/edx-platform +# .. event_trigger: lms/djangoapps/grades/models.py PERSISTENT_GRADE_SUMMARY_CHANGED = OpenEdxPublicSignal( event_type="org.openedx.learning.course.persistent_grade_summary.changed.v1", data={ @@ -193,6 +222,8 @@ # .. event_key_field: xblock_info.usage_key # .. event_description: Fired when an XBlock skill is verified. # .. event_data: XBlockSkillVerificationData +# .. event_trigger_repository: openedx/xblock-skill-tagging +# .. event_trigger: skill_tagging/skill_tagging_mixin.py XBLOCK_SKILL_VERIFIED = OpenEdxPublicSignal( event_type="org.openedx.learning.xblock.skill.verified.v1", data={ @@ -205,6 +236,8 @@ # .. event_description: Can be fired from apps to send user notifications. # .. event_data: UserNotificationSendListData # .. event_warning: This event is currently incompatible with the event bus, list/dict cannot be serialized yet +# .. event_trigger_repository: openedx/edx-platform +# .. event_trigger: lms/djangoapps/discussion/rest_api/discussions_notifications.py USER_NOTIFICATION_REQUESTED = OpenEdxPublicSignal( event_type="org.openedx.learning.user.notification.requested.v1", data={ @@ -216,6 +249,8 @@ # .. event_name: EXAM_ATTEMPT_SUBMITTED # .. event_description: Emitted when an exam attempt is submitted by a learner in edx-exams. # .. event_data: ExamAttemptData +# .. event_trigger_repository: edx/edx-exams +# .. event_trigger: edx_exams/apps/core/signals/signals.py EXAM_ATTEMPT_SUBMITTED = OpenEdxPublicSignal( event_type="org.openedx.learning.exam.attempt.submitted.v1", data={ @@ -227,6 +262,8 @@ # .. event_name: EXAM_ATTEMPT_REJECTED # .. event_description: Emitted when an exam attempt is marked rejected in edx-exams. # .. event_data: ExamAttemptData +# .. event_trigger_repository: edx/edx-exams +# .. event_trigger: edx_exams/apps/core/signals/signals.py EXAM_ATTEMPT_REJECTED = OpenEdxPublicSignal( event_type="org.openedx.learning.exam.attempt.rejected.v1", data={ @@ -238,6 +275,8 @@ # .. event_name: EXAM_ATTEMPT_VERIFIED # .. event_description: Emitted when an exam attempt is marked verified in edx-exams. # .. event_data: ExamAttemptData +# .. event_trigger_repository: edx/edx-exams +# .. event_trigger: edx_exams/apps/core/signals/signals.py EXAM_ATTEMPT_VERIFIED = OpenEdxPublicSignal( event_type="org.openedx.learning.exam.attempt.verified.v1", data={ @@ -249,6 +288,8 @@ # .. event_name: EXAM_ATTEMPT_ERRORED # .. event_description: Emitted when a learner's exam attempt errors out in edx-exams. # .. event_data: ExamAttemptData +# .. event_trigger_repository: edx/edx-exams +# .. event_trigger: edx_exams/apps/core/signals/signals.py EXAM_ATTEMPT_ERRORED = OpenEdxPublicSignal( event_type="org.openedx.learning.exam.attempt.errored.v1", data={ @@ -260,6 +301,8 @@ # .. event_name: EXAM_ATTEMPT_RESET # .. event_description: Emitted when an exam attempt is reset in edx-exams. # .. event_data: ExamAttemptData +# .. event_trigger_repository: edx/edx-exams +# .. event_trigger: edx_exams/apps/core/signals/signals.py EXAM_ATTEMPT_RESET = OpenEdxPublicSignal( event_type="org.openedx.learning.exam.attempt.reset.v1", data={ @@ -284,6 +327,8 @@ # .. event_key_field: course_access_role_data.course_key # .. event_description: Emitted when a course access role is removed from a user. # .. event_data: CourseAccessRoleData +# .. event_trigger_repository: openedx/edx-platform +# .. event_trigger: common/djangoapps/student/signals/signals.py COURSE_ACCESS_ROLE_REMOVED = OpenEdxPublicSignal( event_type="org.openedx.learning.user.course_access_role.removed.v1", data={ @@ -295,6 +340,8 @@ # .. event_name: FORUM_THREAD_CREATED # .. event_description: Emitted when a new thread is created in a discussion # .. event_data: DiscussionThreadData +# .. event_trigger_repository: openedx/edx-platform +# .. event_trigger: lms/djangoapps/discussion/django_comment_client/base/views.py # .. event_warning: This event is currently incompatible with the event bus, list/dict cannot be serialized yet FORUM_THREAD_CREATED = OpenEdxPublicSignal( event_type="org.openedx.learning.thread.created.v1", @@ -307,7 +354,9 @@ # .. event_name: FORUM_THREAD_RESPONSE_CREATED # .. event_description: Emitted when a new response is added to a thread # .. event_data: DiscussionThreadData -# .. event_warning: This event is currently incompatible with the event bus, list/dict cannot be serialized yet +# .. event_trigger_repository: openedx/edx-platform +# .. event_trigger: lms/djangoapps/discussion/django_comment_client/base/views.py +# .. event_warning: This event is currently incompatible with the event bus, list/dict cannot be serialized yet FORUM_THREAD_RESPONSE_CREATED = OpenEdxPublicSignal( event_type="org.openedx.learning.response.created.v1", data={ @@ -319,6 +368,8 @@ # .. event_name: FORUM_RESPONSE_COMMENT_CREATED # .. event_description: Emitted when a new comment is added to a response # .. event_data: DiscussionThreadData +# .. event_trigger_repository: openedx/edx-platform +# .. event_trigger: lms/djangoapps/discussion/django_comment_client/base/views.py # .. event_warning: This event is currently incompatible with the event bus, list/dict cannot be serialized yet FORUM_RESPONSE_COMMENT_CREATED = OpenEdxPublicSignal( event_type="org.openedx.learning.response.created.v1", @@ -332,6 +383,8 @@ # .. event_name: COURSE_NOTIFICATION_REQUESTED # .. event_description: Emitted when a notification is requested for a course # .. event_data: CourseNotificationData +# .. event_trigger_repository: openedx/edx-platform +# .. event_trigger: lms/djangoapps/discussion/rest_api/discussions_notifications.py # .. event_warning: This event is currently incompatible with the event bus, list/dict cannot be serialized yet COURSE_NOTIFICATION_REQUESTED = OpenEdxPublicSignal( event_type="org.openedx.learning.course.notification.requested.v1", @@ -345,6 +398,8 @@ # .. event_name: ORA_SUBMISSION_CREATED # .. event_description: Emitted when a new ORA submission is created # .. event_data: ORASubmissionData +# .. event_trigger_repository: openedx/edx-ora2 +# .. event_trigger: openassessment/xblock/ui_mixins/legacy/handlers_mixin.py # .. event_warning: This event is currently incompatible with the event bus, list/dict cannot be serialized yet ORA_SUBMISSION_CREATED = OpenEdxPublicSignal( event_type="org.openedx.learning.ora.submission.created.v1", @@ -358,6 +413,8 @@ # .. event_name: COURSE_PASSING_STATUS_UPDATED # .. event_description: Emitted when course grade updates. # .. event_data: CoursePassingStatusData +# .. event_trigger_repository: openedx/edx-platform +# .. event_trigger: lms/djangoapps/grades/events.py COURSE_PASSING_STATUS_UPDATED = OpenEdxPublicSignal( event_type="org.openedx.learning.course.passing.status.updated.v1", data={ @@ -370,6 +427,8 @@ # .. event_name: CCX_COURSE_PASSING_STATUS_UPDATED # .. event_description: Emitted when a CCX course grade updates. # .. event_data: CcxCoursePassingStatusData +# .. event_trigger_repository: openedx/edx-platform +# .. event_trigger: lms/djangoapps/grades/events.py CCX_COURSE_PASSING_STATUS_UPDATED = OpenEdxPublicSignal( event_type="org.openedx.learning.ccx.course.passing.status.updated.v1", data={ @@ -382,6 +441,8 @@ # .. event_name: BADGE_AWARDED # .. event_description: Emit when a badge is awarded to a learner # .. event_data: BadgeData +# .. event_trigger_repository: openedx/credentials +# .. event_trigger: credentials/apps/badges/signals/signals.py BADGE_AWARDED = OpenEdxPublicSignal( event_type="org.openedx.learning.badge.awarded.v1", data={ @@ -394,6 +455,8 @@ # .. event_name: BADGE_REVOKED # .. event_description: Emit when a badge is revoked for a learner # .. event_data: BadgeData +# .. event_trigger_repository: openedx/credentials +# .. event_trigger: credentials/apps/badges/signals/signals.py BADGE_REVOKED = OpenEdxPublicSignal( event_type="org.openedx.learning.badge.revoked.v1", data={ @@ -406,6 +469,8 @@ # .. event_name: IDV_ATTEMPT_CREATED # .. event_description: Emitted when an IDV attempt is created # .. event_data: VerificationAttemptData +# .. event_trigger_repository: openedx/edx-platform +# .. event_trigger: lms/djangoapps/verify_student/signals/signals.py IDV_ATTEMPT_CREATED = OpenEdxPublicSignal( event_type="org.openedx.learning.idv_attempt.created.v1", data={ @@ -418,6 +483,8 @@ # .. event_name: IDV_ATTEMPT_PENDING # .. event_description: Emitted when an IDV attempt is marked as pending # .. event_data: VerificationAttemptData +# .. event_trigger_repository: openedx/edx-platform +# .. event_trigger: lms/djangoapps/verify_student/signals/signals.py IDV_ATTEMPT_PENDING = OpenEdxPublicSignal( event_type="org.openedx.learning.idv_attempt.pending.v1", data={ @@ -430,6 +497,8 @@ # .. event_name: IDV_ATTEMPT_APPROVED # .. event_description: Emitted when an IDV attempt is approved # .. event_data: VerificationAttemptData +# .. event_trigger_repository: openedx/edx-platform +# .. event_trigger: lms/djangoapps/verify_student/signals/signals.py IDV_ATTEMPT_APPROVED = OpenEdxPublicSignal( event_type="org.openedx.learning.idv_attempt.approved.v1", data={ @@ -442,6 +511,8 @@ # .. event_name: IDV_ATTEMPT_DENIED # .. event_description: Emitted when an IDV attempt is denied # .. event_data: VerificationAttemptData +# .. event_trigger_repository: openedx/edx-platform +# .. event_trigger: lms/djangoapps/verify_student/signals/signals.py IDV_ATTEMPT_DENIED = OpenEdxPublicSignal( event_type="org.openedx.learning.idv_attempt.denied.v1", data={