Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Update usage.rst #337

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

nwekealex65
Copy link

Added documentation for how to consume messages with a message schema. This addresses #229. It explains how to consume message schema

Added documentation for how to consume messages with a message schema
Validating Messages Against Schema
----------------------------------

Before processing a received message, consumers must validate it against the associated message schema. This ensures that the message structure conforms to the expected format defined in the schema. The `jsonschema` library is commonly used for this purpose within the Fedora Messaging project.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is actually not true, the message is already validated as part of the consuming process (in message.get_message().

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So I should remove this part? any suggestions?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, but that means removing everything actually, because the introduction in "Consuming Messages" is wrong too: it mentions how consumers can validate received messages, and they don't need to.

@abompard
Copy link
Member

This isn't really what Jeremy mentions in the ticket comment.

@nwekealex65
Copy link
Author

@abompard I made some changes to this, can review please?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants