diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 81f6cab3..bb1f1d4b 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -18,6 +18,14 @@ __________ +[9.15.0] - 2024-10-10 +--------------------- + +Changed +~~~~~~~ + +* Added ``background`` field to ``LibraryCollectionData`` so that senders can specify if handlers can run asynchrounously. + [9.14.1] - 2024-09-17 --------------------- diff --git a/openedx_events/__init__.py b/openedx_events/__init__.py index 734bf9c6..bd096725 100644 --- a/openedx_events/__init__.py +++ b/openedx_events/__init__.py @@ -5,4 +5,4 @@ more information about the project. """ -__version__ = "9.14.1" +__version__ = "9.15.0" diff --git a/openedx_events/content_authoring/data.py b/openedx_events/content_authoring/data.py index 4e76bcd7..e5d376fb 100644 --- a/openedx_events/content_authoring/data.py +++ b/openedx_events/content_authoring/data.py @@ -221,7 +221,10 @@ class LibraryCollectionData: Arguments: library_key (LibraryLocatorV2): a key that represents a Blockstore-based content library. collection_key (str): identifies the collection within the library's learning package + background (bool): indicate whether the sender doesn't want to wait for handler to finish execution, + i.e., the handler can run the task in background. By default it is False. """ library_key = attr.ib(type=LibraryLocatorV2) collection_key = attr.ib(type=str) + background = attr.ib(type=bool, default=False) diff --git a/openedx_events/event_bus/avro/tests/schemas/org+openedx+content_authoring+content_library+collection+created+v1_schema.avsc b/openedx_events/event_bus/avro/tests/schemas/org+openedx+content_authoring+content_library+collection+created+v1_schema.avsc index 58b77a50..0c47f299 100644 --- a/openedx_events/event_bus/avro/tests/schemas/org+openedx+content_authoring+content_library+collection+created+v1_schema.avsc +++ b/openedx_events/event_bus/avro/tests/schemas/org+openedx+content_authoring+content_library+collection+created+v1_schema.avsc @@ -16,10 +16,14 @@ { "name": "collection_key", "type": "string" + }, + { + "name": "background", + "type": "boolean" } ] } } ], "namespace": "org.openedx.content_authoring.content_library.collection.created.v1" -} \ No newline at end of file +} diff --git a/openedx_events/event_bus/avro/tests/schemas/org+openedx+content_authoring+content_library+collection+deleted+v1_schema.avsc b/openedx_events/event_bus/avro/tests/schemas/org+openedx+content_authoring+content_library+collection+deleted+v1_schema.avsc index 473d4163..da95e9e0 100644 --- a/openedx_events/event_bus/avro/tests/schemas/org+openedx+content_authoring+content_library+collection+deleted+v1_schema.avsc +++ b/openedx_events/event_bus/avro/tests/schemas/org+openedx+content_authoring+content_library+collection+deleted+v1_schema.avsc @@ -16,10 +16,14 @@ { "name": "collection_key", "type": "string" + }, + { + "name": "background", + "type": "boolean" } ] } } ], "namespace": "org.openedx.content_authoring.content_library.collection.deleted.v1" -} \ No newline at end of file +} diff --git a/openedx_events/event_bus/avro/tests/schemas/org+openedx+content_authoring+content_library+collection+updated+v1_schema.avsc b/openedx_events/event_bus/avro/tests/schemas/org+openedx+content_authoring+content_library+collection+updated+v1_schema.avsc index 54733048..7f581cd5 100644 --- a/openedx_events/event_bus/avro/tests/schemas/org+openedx+content_authoring+content_library+collection+updated+v1_schema.avsc +++ b/openedx_events/event_bus/avro/tests/schemas/org+openedx+content_authoring+content_library+collection+updated+v1_schema.avsc @@ -16,10 +16,14 @@ { "name": "collection_key", "type": "string" + }, + { + "name": "background", + "type": "boolean" } ] } } ], "namespace": "org.openedx.content_authoring.content_library.collection.updated.v1" -} \ No newline at end of file +}