Skip to content

Commit

Permalink
docs: use placeholder instead of specific event for avro schema command
Browse files Browse the repository at this point in the history
  • Loading branch information
mariajgrimaldi committed Dec 9, 2024
1 parent 901e495 commit 856f582
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 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 @@ -128,7 +128,9 @@ As mentioned in the previous step, the serialization and deserialization of the

.. code-block:: bash
python manage.py generate_avro_schemas org.openedx.learning.course.enrollment.changed.v1
python manage.py generate_avro_schemas YOUR_EVENT_TYPE
Run ``python manage.py generate_avro_schemas --help`` to see the available options for the command.

2. The Avro schema for the :term:`Event Payload` will be generated in the ``openedx_events/event_bus/avro/tests/schemas`` directory.
3. Push the changes to the branch and create a pull request or run the checks locally to verify that the Avro schema was generated correctly.
Expand Down

0 comments on commit 856f582

Please sign in to comment.