From ee1b37ffeab50df2b3b381f89eb51447116667d7 Mon Sep 17 00:00:00 2001 From: Navin Karkera Date: Tue, 11 Feb 2025 04:17:26 +0000 Subject: [PATCH] feat: add new signal to indicate new course import (#455) * feat: add new signal to indicate new course import * refactor: rename signal --- CHANGELOG.rst | 8 +++++++ openedx_events/__init__.py | 2 +- openedx_events/content_authoring/signals.py | 13 ++++++++++++ ...ing+course+import+completed+v1_schema.avsc | 21 +++++++++++++++++++ 4 files changed, 43 insertions(+), 1 deletion(-) create mode 100644 openedx_events/event_bus/avro/tests/schemas/org+openedx+content_authoring+course+import+completed+v1_schema.avsc diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 8de55176..4d3f7661 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -16,6 +16,14 @@ Change Log Unreleased __________ +[9.18.0] - 2025-02-06 +--------------------- + +Added +~~~~~ + +* Added new course_authoring signal: ``COURSE_IMPORT_COMPLETED``. + [9.17.0] - 2025-01-30 --------------------- diff --git a/openedx_events/__init__.py b/openedx_events/__init__.py index 625c93aa..ff7ebcd2 100644 --- a/openedx_events/__init__.py +++ b/openedx_events/__init__.py @@ -5,4 +5,4 @@ more information about the project. """ -__version__ = "9.17.0" +__version__ = "9.18.0" diff --git a/openedx_events/content_authoring/signals.py b/openedx_events/content_authoring/signals.py index 86ca4dea..cd01375d 100644 --- a/openedx_events/content_authoring/signals.py +++ b/openedx_events/content_authoring/signals.py @@ -276,3 +276,16 @@ "library_collection": LibraryCollectionData } ) + +# .. event_type: org.openedx.content_authoring.course.import.completed.v1 +# .. event_name: COURSE_IMPORT_COMPLETED +# .. event_key_field: catalog_info.course_key +# .. event_description: Fired after a course is imported +# .. event_data: CourseData +# .. event_trigger_repository: openedx/edx-platform +COURSE_IMPORT_COMPLETED = OpenEdxPublicSignal( + event_type="org.openedx.content_authoring.course.import.completed.v1", + data={ + "course": CourseData, + } +) diff --git a/openedx_events/event_bus/avro/tests/schemas/org+openedx+content_authoring+course+import+completed+v1_schema.avsc b/openedx_events/event_bus/avro/tests/schemas/org+openedx+content_authoring+course+import+completed+v1_schema.avsc new file mode 100644 index 00000000..3e00fa91 --- /dev/null +++ b/openedx_events/event_bus/avro/tests/schemas/org+openedx+content_authoring+course+import+completed+v1_schema.avsc @@ -0,0 +1,21 @@ +{ + "name": "CloudEvent", + "type": "record", + "doc": "Avro Event Format for CloudEvents created with openedx_events/schema", + "fields": [ + { + "name": "course", + "type": { + "name": "CourseData", + "type": "record", + "fields": [ + { + "name": "course_key", + "type": "string" + } + ] + } + } + ], + "namespace": "org.openedx.content_authoring.course.import.completed.v1" +}