docs: add events_status to code-annotations

openedx · Jul 29, 2021 · b512e12 · b512e12
1 parent 9e7fa04
commit b512e12
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/openedx_events/learning/signals.py b/openedx_events/learning/signals.py
@@ -15,6 +15,7 @@
 # .. event_name: STUDENT_REGISTRATION_COMPLETED
 # .. event_description: emitted when the user registration process in the LMS is completed.
 # .. event_data: UserData
+# .. event_status: provisional
 STUDENT_REGISTRATION_COMPLETED = OpenEdxPublicSignal(
     event_type="org.openedx.learning.student.registration.completed.v1",
     data={
@@ -27,6 +28,7 @@
 # .. event_name: SESSION_LOGIN_COMPLETED
 # .. event_description: emitted when the user's login process in the LMS is completed.
 # .. event_data: UserData
+# .. event_status: provisional
 SESSION_LOGIN_COMPLETED = OpenEdxPublicSignal(
     event_type="org.openedx.learning.auth.session.login.completed.v1",
     data={
@@ -39,6 +41,7 @@
 # .. event_name: COURSE_ENROLLMENT_CREATED
 # .. event_description: emitted when the user's enrollment process is completed.
 # .. event_data: CourseEnrollmentData
+# .. event_status: provisional
 COURSE_ENROLLMENT_CREATED = OpenEdxPublicSignal(
     event_type="org.openedx.learning.course.enrollment.created.v1",
     data={
@@ -51,6 +54,7 @@
 # .. event_name: COURSE_ENROLLMENT_CHANGED
 # .. event_description: emitted when the user's enrollment update process is completed.
 # .. event_data: CourseEnrollmentData
+# .. event_status: provisional
 COURSE_ENROLLMENT_CHANGED = OpenEdxPublicSignal(
     event_type="org.openedx.learning.course.enrollment.changed.v1",
     data={
@@ -63,6 +67,7 @@
 # .. event_name: COURSE_ENROLLMENT_CHANGED
 # .. event_description: emitted when the user's unenrollment process is completed.
 # .. event_data: CourseEnrollmentData
+# .. event_status: provisional
 COURSE_UNENROLLMENT_COMPLETED = OpenEdxPublicSignal(
     event_type="org.openedx.learning.course.unenrollment.completed.v1",
     data={
@@ -75,6 +80,7 @@
 # .. event_name: CERTIFICATE_CREATED
 # .. event_description: emitted when the user's certificate creation process is completed.
 # .. event_data: CertificateData
+# .. event_status: provisional
 CERTIFICATE_CREATED = OpenEdxPublicSignal(
     event_type="org.openedx.learning.certificate.created.v1",
     data={
@@ -87,6 +93,7 @@
 # .. event_name: CERTIFICATE_CREATED
 # .. event_description: emitted when the user's certificate creation process is completed.
 # .. event_data: CertificateData
+# .. event_status: provisional
 CERTIFICATE_CHANGED = OpenEdxPublicSignal(
     event_type="org.openedx.learning.certificate.changed.v1",
     data={
@@ -99,6 +106,7 @@
 # .. event_name: CERTIFICATE_REVOKED
 # .. event_description: emitted when the user's certificate annulation process is completed.
 # .. event_data: CertificateData
+# .. event_status: provisional
 CERTIFICATE_REVOKED = OpenEdxPublicSignal(
     event_type="org.openedx.learning.certificate.revoked.v1",
     data={
@@ -111,6 +119,7 @@
 # .. event_name: COHORT_MEMBERSHIP_CHANGED
 # .. event_description: emitted when the user's cohort update is completed.
 # .. event_data: CohortData
+# .. event_status: provisional
 COHORT_MEMBERSHIP_CHANGED = OpenEdxPublicSignal(
     event_type="org.openedx.learning.cohort_membership.changed.v1",
     data={