Skip to content

adding message_id in the subscribe and on_subscribe APIs#487

Merged
emmayank merged 1 commit into
beckn:masterfrom
rajaneeshk90:registry-specification-fixes
Jul 2, 2025
Merged

adding message_id in the subscribe and on_subscribe APIs#487
emmayank merged 1 commit into
beckn:masterfrom
rajaneeshk90:registry-specification-fixes

Conversation

@rajaneeshk90
Copy link
Copy Markdown
Contributor

✨ Schema Enhancement: Addition of message_id in Registry Specification

Summary

This PR introduces a key schema update to the Beckn Registry Specification — the addition of the message_id field to improve message traceability and alignment with asynchronous communication patterns.


✅ What’s Changed

1. Schema Enhancement – message_id Added

  • message_id field (type: string) has been added to:
    • api/registry/build/registry.yaml
    • api/registry/components/io/OnSubscribe.yaml
    • schema/Subscription.yaml
  • This enables better end-to-end correlation of messages exchanged between network participants.

2. Refactor of File Paths and Build Instructions

  • Migrated registry compilation structure from core/v0/api/ to api/registry/.
  • Updated paths and references in:
    • Schema index file
    • OpenAPI entry file (index.yaml)
    • Build command instructions using swagger-cli
  • Ensured consistency in folder structure and YAML resolution flow.

🔍 Why It Matters

  • message_id is crucial for debugging and tracing workflows, especially in distributed or asynchronous messaging scenarios.
  • The file structure refactor improves modularity and makes the spec more maintainable and intuitive.

🧪 How It Was Tested

  • Verified OpenAPI bundle using:
    swagger-cli bundle api/registry/components/index.yaml --outfile api/registry/build/registry.yaml --type yaml

@rajaneeshk90 rajaneeshk90 self-assigned this Jun 20, 2025
@rajaneeshk90 rajaneeshk90 linked an issue Jun 20, 2025 that may be closed by this pull request
@emmayank emmayank requested a review from ravi-prakash-v June 26, 2025 09:11
@emmayank emmayank merged commit f30935f into beckn:master Jul 2, 2025
@emmayank
Copy link
Copy Markdown
Contributor

emmayank commented Jul 3, 2025

Subsequent changes are merged here - #488

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.

Add Context to subscribe and OnSubscribe request body.

2 participants