Skip to content

Commit

Permalink
docs: rewrite introduction to step-by-step avro schema generation guide
Browse files Browse the repository at this point in the history
  • Loading branch information
mariajgrimaldi committed Dec 9, 2024
1 parent 51683fd commit fbf38cf
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/how-tos/adding-event-bus-support-to-an-event.rst
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ If your :term:`Event Payload` contains only supported data types, you can skip t
Step 4: Generate the Avro Schema
--------------------------------

As mentioned in the previous step, the serialization and deserialization of the :term:`Event Payload` is handled by the concrete event bus implementation with the help of methods implemented in this library. However, although openedx-events does not handles the serialization and deserialization of the :term:`Event Payload` directly, it ensures the payload of new events can be serialized and deserialized correctly by adding checks in the CI/CD pipeline for schema verification. To ensure this, you need to generate the Avro schema for the :term:`Event Payload`:
As mentioned in the previous step, the serialization and deserialization of the :term:`Event Payload` is handled by the concrete event bus implementation with the help of methods implemented in this library. However, although openedx-events does not handles the serialization and deserialization of the :term:`Event Payload` directly, it ensures the payload of new events can be serialized and deserialized correctly by adding checks in the CI/CD pipeline for schema verification. To ensure tests pass, you need to generate an Avro test schema for your new event's :term:`Event Payload`:

1. Run the following command to generate the Avro schema for the :term:`Event Payload`:

Expand Down

0 comments on commit fbf38cf

Please sign in to comment.