Define a schema for the beckn.json document #470
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…s components - Updating the existing Credential Objects in the schema/ folder, adding more details in it - Adding the Credntial schema in Agent, Customer, Organisation, Payment, Provider, Subscriber, Fulfillment, Item, Order objects - Added 2 more endpoints, cred/ and on_cred/
…ot standarised by VC specification
…o credentialSchema
… it backword compatible.
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
As per the discussions, it was decided that to represent platform level credentials, we will use a beckn.json file, which will be accessed at <bpp_uri/bap_uri>/beckn.json.
Other platforms should be able to fetch this using a <bpp_uri/bap_uri>/beckn.json url.
This PR defines the schema for the beckn.json using jsonSchema.
Summary
The current proposed schema for beckn.json has 2 fields.
credentials: This is an array of credentials object. The schema of each credential object in the array is same as the Credential object defined in the Beckn Core protocol specification. This array would have a list of credentials that a platform has. For example, there could be a credential to represent if a platform is UEI verified.
layer2config: This filed would have the link to a layer 2 config file. A Layer2 configuration file contains the network specific business rules corresponding to a network.
Changes
api/about-endpointis created.api/about-endpoint/about.jsonis created which defines the template for the beckn.json content.api/about-endpoint/becknVerifiableCredential.jsonwas generated programatically usingjson-dereferencecli command. This process uses the existing schema/Credential.yaml file to generate theapi/about-endpoint/becknVerifiableCredential.jsonfile.api/about-endpoint/beckn.jsonwas generated programmatically usingjson-dereferencecli command.Migration Impact
The changes are fully backward compatible. All modifications involved either the creation of new schemas or the addition of new fields to existing schemas.