fedora-infra / fedora-messaging

A library for sending AMQP messages with JSON schema in Fedora infrastructure
GNU General Public License v2.0
52 stars 52 forks source link

Improving 'id' schema documentation #350

Open vidit-maheshwari opened 3 months ago

vidit-maheshwari commented 3 months ago

Summary:

Fixes #220 This PR updates the documentation to provide clarity on the usage of the id (or $id) field in message schemas within Fedora Messaging.

Description:

This PR updates the documentation to provide clarity on the usage of the id (or $id) field in message schemas within Fedora Messaging. The id field serves as a URI identifier for each schema, distinguishing between different schema packages. It is important to maintain consistency within a specific schema package while ensuring uniqueness across packages.

Changes Made:

Updated the documentation to emphasize the purpose and significance of the id field in message schemas.