beckn / beckn/DSEP-Specification

Specification Misalignment: Discrepancies Between the DSEP spec and the referenced Core Spec

Open
#164 1 comment 0 reactions 0 assignees View on GitHub
bug
Dominant language
No language data
Stars
21
Forks
20
PR merge metrics
No merged PRs in 30d

Description

**Issue Details:**

**Problem Statement:**
The DSEP specification outlined in the /api folder([link to the DSEP specification definition](https://github.com/beckn/DSEP-Specification/blob/draft/api/dsep-v0.7.0.yaml)) references the core spec version 1.1.0, but discrepancies exist in their adherence to the referenced core spec. The discrepancies are listed below.

**1. The structure of the DSEP specification deviates from the Beckn core specification in the handling of **location** information. For instance:**

In the Beckn core protocol specification context, the **location** object encapsulates both **city** and **country**:

```
"location": {
"city": {
"name": "Bangalore",
"code": "std:080"
},
"country": {
"name": "India",
"code": "IND"
}
}
```
However, the DSEP specification does not include a **location** object within **context**. Instead, **city** and **country** are directly placed inside **context**:

```
"country": "IND",
"city": "std:080"
```

**2. The examples that are used in the specification yaml (dsep-v0.7.yaml) are not as per the core-v1.1 specification.** [Link](https://github.com/beckn/DSEP-Specification/blob/master/api/dsep-v0.7.0.yaml#L55)
**3. Unused components are present in the specification yaml. For example, Policy, StructuredAddress, FullAddress, FeedbackUrl, FeedbackFormElement, FeedbackForm & Feedback schema is defined in the dsep-v0.7.yaml but are not used.**
**4. Rating & on_rating specs is not as per core-v1.1.yaml** [Link](https://github.com/beckn/DSEP-Specification/blob/master/api/dsep-v0.7.0.yaml#L549)

It is essential to investigate these inconsistencies and rectify the misalignment between the DSEP specification and the referenced Beckn core protocol specification.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by comparing api/dsep-v0.7.0.yaml with the referenced Beckn core-v1.1 specification, focusing on context location, the examples, unused components, and Rating/on_rating. Done means the DSEP schemas and examples are aligned with core-v1.1 and unused definitions are removed or justified.

Written by the indexing model from the issue text.

Assessment

Tech stack
yaml
Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.