Layer 2 configuration creation and maintenance

Open
  • Is something wrong?
#426 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Domain
api

Research direction

Start by reviewing the supported sandbox and Experience Center examples, the {domain}_{version}.yaml naming convention, and the planned download script. Confirm domain-name standardization, layer 2 configuration ownership, and the repository location with the spec team; done means those decisions are settled and the required configurations can be maintained and consumed.

Written by the indexing model from the issue text.

Description

Protocol Standard - Recommended protocol-specifications

Beckn-ONIX requires layer 2 configuration files to be present for the domain name(field name - domain) and core spec version (field name - version) specified in the message context. These layer 2 configuration currently are all encompassing yaml file with domain specific and network specific rules. The reference Beckn Adapter expects them to be present in its file system with the name `{domain}_{version}.yaml) With regards to this, we have the following issues:

  1. We will need a yaml file for each domain name used in the examples we support in sandbox and those that we use in Experience Center.
  2. The spec team is publishing 1.1 complaint domain specs. We need to ensure this covers all the examples and EC apps.
  3. Currently the domain names are not standardized. e.g in sandbox and EC we use the name desp:courses while in the examples in the repository, we use onest:learning-experiences
  4. The domain specs currently only use examples and not any rules. So essentially from a validation perspective, they are identical to core spec. The spec team will gradually be modifying this to make it more featureful.

Towards the above, we need an understanding with the spec team. I am assuming that a few of these will be sorted out.

  1. Standardization of domain names for the published examples and EC apps.
  2. Ownership of layer 2 configuration files
  3. A place to update these files on github, so users of Beckn-ONIX can use that in the download script.
Dominant language
No language data
Stars
455
Forks
127
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from beckn/protocol-specifications

All issues in beckn/protocol-specifications

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.