Beckn Protocol Version 1.1.1 : Patch Version Release Notes

Overview

This patch release introduces an enhancement to the Beckn Protocol by upgrading the representation of the API specification to OpenAPI 3.1 from the previous OpenAPI 3.0. This update enables more robust and complex validation logic to be encoded directly into the specification, ensuring a higher degree of precision and flexibility in schema definitions.

This is especially useful for design Layer 2 configs for adapters like Beckn-ONIX

Key Changes

1. Upgrade to OpenAPI 3.1

   • Beckn Protocol API specifications are now represented using OpenAPI 3.1.
   • This upgrade brings improved support for JSON Schema, enabling the use of advanced validation features like conditional logic (if/then/else), unevaluatedProperties, and more.
   • Enhances the ability to define reusable components and enforce stricter schema constraints for all endpoints.

2. Improved Validation Logic

   • Complex validation rules can now be expressed directly within the API schema, reducing implementation ambiguity.
   • Offers better alignment with modern tools and libraries that support OpenAPI 3.1.

3. Backward Compatibility

   • The schema upgrade does not impact existing functionality but enhances how developers define and validate API interactions.
   • Existing implementations can migrate seamlessly by adopting the new specification file.

Benefits of the Update

• Enhanced Accuracy: Improved schema definition and validation mechanisms reduce implementation errors.
• Developer Efficiency: Simplified development workflows with support for modern tooling that leverages OpenAPI 3.1 features.
• Future-Ready: Ensures Beckn Protocol remains aligned with evolving API standards.

Call to Action

We encourage all developers and platform providers to update their API tools and workflows to support OpenAPI 3.1.

Beckn Protocol Version 1.1.0 : Minor Version Release

What's Changed

• Release 1.x by @ravi-prakash-v in #347
• Added Issue templates for GitHub
• Bugfixes in OpenAPI syntax
• Updated descriptions in some schema
• Removed form_submission attribute from XInput schema

Full Changelog: core-v1.0.0...core-v1.1.0

Core 0.9.4 - Updates to 0.9.x LTS version

This release contains updates to the core-0.9.x long term support version. This release can be found on the core-0.9.x-lts branch,

Change summary

1. Added RFC for Tags schema
2. Updated Tags schema
3. Updated Order object to include full Item schema in the Order.items property instead of just id and quantity
4. Sending complete Order schema in select and init requests
5. Added max_callbacks property to Context schema

Full Changelog can be found here: beckn-core-0.9.3...core-0.9.4

Beckn Protocol Version 1.0.0 : Major Version Release

Summary

Beckn Open Collective presents Beckn Protocol Specification Version 1.0. This major release contains a significantly abstracted and unified protocol specfication and recommendations from the Core Working Group. The following release note summarize the changes that have been made to the protocol since its last release version 0.9.3. More details will be added in subsequent minor releases.

Changelog

Full Changelog can be found here: beckn-core-0.9.3...core-v1.0.0

Reviewers

@ravi-prakash-v
@pramodkvarma
@sjthnrk
@venkatramanm

What's Changed

• Error codes by @BLR-0118 in #210
• Add collected_by to Payment by @BLR-0118 in #204
• Update item description by @techframewirk in #236
• Fix tl_method values in BECKN-002-Payments-On-Beckn-Enabled-Networks.md by @BLR-0118 in #233
• Update core.yaml by @BLR-0118 in #225
• Remove BLAKE-512 from auth header description by @BLR-0118 in #206
• RFC - Rating and Reputation on Beckn Protocol by @techframewirk in #240
• Pub sub Proposal by @venkatramanm in #208
• Solution for Issue #243 by @AyushAgrawal25 in #244
• Added link to community guidelines by @techframewirk in #245
• Adding CC-BY-NC-SA License by @ravi-prakash-v in #261
• Governance and Licensing Updates by @ravi-prakash-v in #262
• Governance main by @ravi-prakash-v in #263
• Changed the current draft version by @abhimail in #265
• Governance main by @ravi-prakash-v in #271
• Updated descriptions of schema level objects by @techframewirk in #242
• Ecosystem fixes by @ravi-prakash-v in #296
• Ecosystem fixes by @ravi-prakash-v in #297
• PR for Release Version 1.x by @ravi-prakash-v in #298
• Rfc 15 08 2022 by @ravi-prakash-v in #305
• PR to release 1.x branch by @ravi-prakash-v in #299
• Split big core yaml into smaller files for maintainabilty by @venkatramanm in #308
• Release 1.x review by @ravi-prakash-v in #319
• Added Rating To Agent Schema by @joffinjoy in #325
• Added Skills To Person Schema by @joffinjoy in #326
• Added Languages To Person Schema by @joffinjoy in #327
• Token id not found error by @venkatramanm in #333
• Added Descriptor schema in TagGroup and tag and removed name and code by @sanjay95 in #334
• Core Version 1.0 by @ravi-prakash-v in #341

New Contributors

• @BLR-0118 made their first contribution in #210
• @AyushAgrawal25 made their first contribution in #244
• @abhimail made their first contribution in #265
• @joffinjoy made their first contribution in #325
• @sanjay95 made their first contribution in #334

core-0.9.3

What's new

• New authorization header X-Gateway-Authorization to replace Proxy-Authorization
• New rating flow
• All meta APIs are async as well
• Time object has schedule which can be used to represent schedules
• Documents related to an order can be represented

Bug fixes and improvements

• Made structure of all APIs more uniform
• Improvements in Payment schema object
• Rating property for Item, Provider and Fulfillment

Full changelog can be found on CHANGELOG.md

Contributors

• @core-wg-admin
• @pramodkvarma
• @techframewirk
• @sjthnrk
• @pkapustin
• @venkatramanm